Skip to content

Add changelog entry for Python library docs#3960

Open
paarthfern wants to merge 3 commits intomainfrom
devin/1772465638-changelog-library-docs
Open

Add changelog entry for Python library docs#3960
paarthfern wants to merge 3 commits intomainfrom
devin/1772465638-changelog-library-docs

Conversation

@paarthfern
Copy link
Contributor

@paarthfern paarthfern commented Mar 2, 2026

Summary

Adds a changelog entry (2026-03-02.mdx) for the Python library docs feature in the Docs product changelog. The entry describes the ability to generate Python library reference documentation from SDK source code using fern docs md generate.

Tagged as api-reference and configuration. Vale linting passes with no errors or warnings.

Updates since last revision

  • Added CLI commands and usage details per reviewer request:
    • Full docs.yml configuration example showing libraries config and library navigation item
    • fern docs md generate CLI command
    • Brief explanation of what the command does (server-side parsing, local MDX generation)
  • Removed _navigation.yml implementation detail per reviewer request

The config structure (input.git, output.path, lang) was derived from the CLI source schemas (LibraryConfigurationSchema.ts, LibraryReferenceConfigurationSchema.ts), not from an existing published example.

Review & Testing Checklist for Human

  • Verify the docs.yml configuration example is accurate — the structure was inferred from CLI source code schemas, not copied from an official example or existing customer config
  • Verify the feature description and workflow accurately reflects what shipped (sourced from CLI changelogs 2026-02-06 through 2026-02-13)
  • Decide if a "Learn more" link should be added — no dedicated docs page for library docs was found in the repo, so one was omitted
  • Preview the rendered entry at the preview URL and confirm formatting looks correct

Notes

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

🤖 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 Mar 2, 2026

🌿 Preview your docs: https://fern-preview-1ac7dbfe-a238-4740-896e-b52190fb5a7d.docs.buildwithfern.com/learn

Here are the markdown pages you've updated:

devin-ai-integration bot and others added 2 commits March 2, 2026 15:44
Co-Authored-By: paarth <paarth@buildwithfern.com>
Co-Authored-By: paarth <paarth@buildwithfern.com>
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