Document git input support for fern docs md generate --local - #6734
Closed
fern-api[bot] wants to merge 3 commits into
Closed
fern-api[bot] wants to merge 3 commits into
fern-api[bot] wants to merge 3 commits into
Conversation
| @@ -1,3 +1,11 @@ | |||
| ## 5.103.0 | |||
| **`(feat):`** `fern docs md generate --local` now resolves library documentation inputs from git | |||
Contributor
There was a problem hiding this comment.
Avoid time-relative terms like 'now' that become outdated
|
|
||
| <ChangelogTags>api-reference, docs.yml</ChangelogTags> | ||
|
|
||
| `fern docs md generate --local` now works with `git` [library inputs](/learn/docs/api-references/library-reference), not just local `path` inputs. The CLI shallow-clones the repository on your machine, respecting the configured `ref` and `subpath`, runs the parser in Docker, and cleans up the temporary checkout automatically. No data is sent to Fern's servers. |
Contributor
There was a problem hiding this comment.
📝 [vale] <FernStyles.Hedges> reported by reviewdog 🐶
Avoid hedge words and filler like 'just'. Prefer direct statements.
Contributor
|
🌿 Preview your docs: https://fern-preview-2026-08-24-fern-ai-fe3932-e9528341.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.
The library docs generator page now documents that
--localworks with bothgitandpathinputs: the intro explains agitinput is parsed remotely unless--localis passed, the generate step showsfern docs md generate --localfor git inputs (shallow clone at the configuredref,subpathmounted for parsing, temporary checkout removed on exit, nothing sent to Fern's servers), the Docker requirement now applies to both input types, and the configuration reference notesrefandsubpathare respected during local generation whileinput.pathsimply requires--local. The CLI--localflag reference was updated to match, and changelog entries dated 2026-08-24 were added for the CLI (5.103.0) and for Docs. No navigation changes were needed because both changelog directories are auto-discovered viachangelog:entries.