Add library docs documentation page as top-level section#3606
Open
devin-ai-integration[bot] wants to merge 3 commits intomainfrom
Open
Add library docs documentation page as top-level section#3606devin-ai-integration[bot] wants to merge 3 commits intomainfrom
devin-ai-integration[bot] wants to merge 3 commits intomainfrom
Conversation
Co-Authored-By: paarth@buildwithfern.com <paarth@buildwithfern.com>
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
|
🌿 Preview your docs: https://fern-preview-1240d478-3d2f-4784-b200-34a2b03b098d.docs.buildwithfern.com/learn Here are the markdown pages you've updated: |
Co-Authored-By: paarth@buildwithfern.com <paarth@buildwithfern.com>
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.
Summary
Adds a new documentation page for the library docs feature (beta), which generates browsable reference documentation from library source code. The page is placed as a top-level "Library references" section in the docs navigation, with a beta availability badge.
Changes:
generate-library-ref.mdxcovering configuration (librariesindocs.yml), thefern docs md generateCLI command, thelibrarynavigation item, and a configuration reference withParamFieldentriesdocs.ymlwithavailability: betaReview & Testing Checklist for Human
--libraryflag name: The CLI flag was inferred from readinggenerateLibraryDocs.tssource (library: string | undefined), but the actual CLI argument name was not tested. Confirm thatfern docs md generate --library <name>is the correct invocation.librariessection schema andlibrarynavigation item were authored from reading CLI source code, not from tested examples. Verify the YAML structures match what the CLI actually expects./learn/docs/library-references/generate-library-refresolves correctly in the preview.Suggested test plan: Open the preview link above, verify the "Library references" section appears as a top-level nav item with a beta badge, click through the page content, and confirm the changelog entry at
/learn/docs/changelog/2026/2/12links back correctly.Notes
fern-api/fern(specificallypackages/cli/library-docs-generator/,packages/cli/cli/src/commands/docs-md-generate/generateLibraryDocs.ts, and thedocs-ymlconfiguration types).fern docs devrendering was verified — page renders correctly as a top-level section with the supported languages table showing both Python and C++.pages/api-references/on disk but is referenced from the top-level "Library references" nav section indocs.yml. This works but could be moved to its own directory for consistency if preferred.