Skip to content

docs: --local supports git library inputs - #6736

Merged
Ryan-Amirthan merged 4 commits into
mainfrom
devin/1787614438-local-library-git-inputs
Aug 24, 2026
Merged

docs: --local supports git library inputs#6736
Ryan-Amirthan merged 4 commits into
mainfrom
devin/1787614438-local-library-git-inputs

Conversation

@Ryan-Amirthan

@Ryan-Amirthan Ryan-Amirthan commented Aug 24, 2026

Copy link
Copy Markdown
Contributor

Summary

fern-api/fern#17510 (CLI 5.103.0) removed the restriction that fern docs md generate --local only accepted path library inputs. git inputs are now parsed locally too, at the configured ref and honoring subpath.

Docs changes:

  • Library Reference: the input tabs are no longer labeled "(remote)"/"(local)", and the generate-step tabs are re-cut by where parsing happens rather than by input type.
  • Config reference: input.git works with --local; input.ref documented as branch, tag, or commit SHA; the C++ Doxyfile note now resolves paths against the source root (input.path, or the repository root for a git input) instead of always input.path.
  • CLI reference fern docs md generate --local description updated to match.
  • New Docs changelog entry for 2026-08-24.

Link to Devin session: https://app.devin.ai/sessions/8a2ce83d060e4ee185798aec35b2d36d
Requested by: @Ryan-Amirthan

Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
@devin-ai-integration

Copy link
Copy Markdown
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, CI, and merge conflict monitoring

@github-actions

Copy link
Copy Markdown
Contributor

Ryan-Amirthan and others added 3 commits August 24, 2026 23:42
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.

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.

@Ryan-Amirthan
Ryan-Amirthan merged commit d53c1c0 into main Aug 24, 2026
4 checks passed
@Ryan-Amirthan
Ryan-Amirthan deleted the devin/1787614438-local-library-git-inputs branch August 24, 2026 23:56
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.

2 participants