Skip to content

Add library docs documentation page as top-level section#3606

Open
devin-ai-integration[bot] wants to merge 3 commits intomainfrom
devin/1770928729-library-docs
Open

Add library docs documentation page as top-level section#3606
devin-ai-integration[bot] wants to merge 3 commits intomainfrom
devin/1770928729-library-docs

Conversation

@devin-ai-integration
Copy link
Contributor

@devin-ai-integration devin-ai-integration bot commented Feb 12, 2026

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:

  • New page generate-library-ref.mdx covering configuration (libraries in docs.yml), the fern docs md generate CLI command, the library navigation item, and a configuration reference with ParamField entries
  • Top-level "Library references" section in docs.yml with availability: beta
  • Supported languages table: Python (Beta), C++ (In development)
  • Changelog entry for 2026-02-12

Review & Testing Checklist for Human

  • Verify --library flag name: The CLI flag was inferred from reading generateLibraryDocs.ts source (library: string | undefined), but the actual CLI argument name was not tested. Confirm that fern docs md generate --library <name> is the correct invocation.
  • Review configuration examples: The libraries section schema and library navigation item were authored from reading CLI source code, not from tested examples. Verify the YAML structures match what the CLI actually expects.
  • Check preview rendering: Verify the page renders correctly in the preview deployment, especially the Steps component, ParamField components, and the supported languages table.
  • Validate changelog link: Confirm /learn/docs/library-references/generate-library-ref resolves 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/12 links back correctly.

Notes

  • Documentation was authored by reading the CLI source code in fern-api/fern (specifically packages/cli/library-docs-generator/, packages/cli/cli/src/commands/docs-md-generate/generateLibraryDocs.ts, and the docs-yml configuration types).
  • Local fern docs dev rendering was verified — page renders correctly as a top-level section with the supported languages table showing both Python and C++.
  • The page file lives in pages/api-references/ on disk but is referenced from the top-level "Library references" nav section in docs.yml. This works but could be moved to its own directory for consistency if preferred.
  • Vale style checks pass with zero warnings on all changed files.
  • Link to Devin run
  • Requested by: paarth@buildwithfern.com

Open with Devin

Co-Authored-By: paarth@buildwithfern.com <paarth@buildwithfern.com>
@devin-ai-integration
Copy link
Contributor Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

@github-actions
Copy link
Contributor

github-actions bot commented Feb 12, 2026

Copy link
Contributor Author

@devin-ai-integration devin-ai-integration bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ Devin Review: No Issues Found

Devin Review analyzed this PR and found no potential bugs to report.

View in Devin Review to see 2 additional findings.

Open in Devin Review

Co-Authored-By: paarth@buildwithfern.com <paarth@buildwithfern.com>
@devin-ai-integration devin-ai-integration bot changed the title Add library docs documentation page and changelog entry Add library docs documentation page as top-level section Feb 12, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant