Skip to content

Document git input support for fern docs md generate --local - #6734

Closed
fern-api[bot] wants to merge 3 commits into
mainfrom
2026-08-24-fern-ai-fe3932-e9528341
Closed

fern-api[bot] wants to merge 3 commits into
mainfrom
2026-08-24-fern-ai-fe3932-e9528341

Conversation

@fern-api

@fern-api fern-api Bot commented Aug 24, 2026

Copy link
Copy Markdown
Contributor

The library docs generator page now documents that --local works with both git and path inputs: the intro explains a git input is parsed remotely unless --local is passed, the generate step shows fern docs md generate --local for git inputs (shallow clone at the configured ref, subpath mounted 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 notes ref and subpath are respected during local generation while input.path simply requires --local. The CLI --local flag 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 via changelog: entries.

@@ -1,3 +1,11 @@
## 5.103.0
**`(feat):`** `fern docs md generate --local` now resolves library documentation inputs from git

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

⚠️ [vale] <FernStyles.Current> reported by reviewdog 🐶
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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

📝 [vale] <FernStyles.Hedges> reported by reviewdog 🐶
Avoid hedge words and filler like 'just'. Prefer direct statements.

@github-actions

Copy link
Copy Markdown
Contributor

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