Open
Conversation
Contributor
Author
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
Contributor
|
Requested by: paarth |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| Fern can generate reference documentation for your client libraries (e.g., Python SDKs) directly from source code. Library docs are auto-generated MDX pages that document modules, classes, methods, and parameters — rendered as first-class sections in your docs site. | ||
|
|
||
| <Note> | ||
| Library docs is currently in **beta**. Python and C++ are supported today. |
Contributor
There was a problem hiding this comment.
[FernStyles.Current] Avoid time-relative terms like 'currently' that become outdated
| Fern can generate reference documentation for your client libraries (e.g., Python SDKs) directly from source code. Library docs are auto-generated MDX pages that document modules, classes, methods, and parameters — rendered as first-class sections in your docs site. | ||
|
|
||
| <Note> | ||
| Library docs is currently in **beta**. Python and C++ are supported today. |
Contributor
There was a problem hiding this comment.
[FernStyles.Current] Avoid time-relative terms like 'today' that become outdated
Contributor
|
🌿 Preview your docs: https://fern-preview-e3d803c6-51ca-492c-8963-2585006bbdd4.docs.buildwithfern.com/learn Here are the markdown pages you've updated: |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add library docs page
Summary
Adds a new documentation page for the Library Docs feature (beta) — Fern's ability to generate reference documentation for client libraries directly from source code. The page is placed in the API References > Generation section of the Docs product, alongside the existing REST, Webhook, WebSocket, OpenRPC, gRPC, and GraphQL reference pages.
The page covers:
librariesconfig →fern docs md generate→librarynav item workflow)libraries(top-level) andlibrary(navigation item)Content was derived from the Fern CLI schema (
docs.ymlAPI definition), fern-platformLibraryDocsService, and CLI changelog entries (v3.42–v3.78).Updates since last revision
Review & Testing Checklist for Human
librariesconfig shape,fern docs md generatecommand behavior, andlibrarynavigation item properties.<Steps>,<Note>, code block highlighting, and markdown tables.Notes