Conversation
🤖 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:
|
|
Requested by: paarth |
| 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. |
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. |
There was a problem hiding this comment.
[FernStyles.Current] Avoid time-relative terms like 'today' that become outdated
|
🌿 Preview your docs: https://fern-preview-e3d803c6-51ca-492c-8963-2585006bbdd4.docs.buildwithfern.com/learn Here are the markdown pages you've updated: |
|
This PR is stale because it has been open 25 days with no activity. Remove stale label or comment or this will be closed in 5 days. |
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