docs: --local supports git library inputs - #6736
Merged
Merged
Conversation
Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Contributor
🤖 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-devin-1787614438-local-library-git-inputs.docs.buildwithfern.com/learn Here are the markdown pages you've updated: |
Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
|
|
||
| <ChangelogTags>api-reference, local-development</ChangelogTags> | ||
|
|
||
| You can now iterate on library docs locally from `git` inputs, not just `path` inputs. `fern docs md generate --local` reads the library source from the repository at the configured `ref` and parses it on your machine, so you can preview generated pages without publishing or logging in to Fern. |
Contributor
There was a problem hiding this comment.
📝 [vale] <FernStyles.Hedges> reported by reviewdog 🐶
Avoid hedge words and filler like 'just'. Prefer direct statements.
devalog
approved these changes
Aug 24, 2026
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
fern-api/fern#17510 (CLI 5.103.0) removed the restriction that
fern docs md generate --localonly acceptedpathlibrary inputs.gitinputs are now parsed locally too, at the configuredrefand honoringsubpath.Docs changes:
input.gitworks with--local;input.refdocumented as branch, tag, or commit SHA; the C++ Doxyfile note now resolves paths against the source root (input.path, or the repository root for agitinput) instead of alwaysinput.path.fern docs md generate --localdescription updated to match.Link to Devin session: https://app.devin.ai/sessions/8a2ce83d060e4ee185798aec35b2d36d
Requested by: @Ryan-Amirthan