docs: clarify git-ref version constraints in docs.yml - #6574
Open
devin-ai-integration[bot] wants to merge 1 commit into
Open
docs: clarify git-ref version constraints in docs.yml#6574devin-ai-integration[bot] wants to merge 1 commit into
devin-ai-integration[bot] wants to merge 1 commit into
Conversation
Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Contributor
Author
🤖 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-1786208887-git-ref-versions.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.
Summary
Git-ref-based docs versioning lets a
versions:entry indocs.ymlname a git branch, tag, or commit SHA instead of apathinto the working tree. Customers can keep an older docs version in git history rather than copying its content into the current tree, and it still publishes with the current site's theme, shell, and version dropdown. This PR fills the remaining gaps in the existing versioning docs: theref/pathmutual exclusion, what the CLI needs at the ref, and how missing SDK reference output is handled.Implements docs for: feat(cli): add git-ref-based docs versioning (fern-api/fern#17288)
Changes
fern/products/docs/pages/navigation/versions.mdx— the "Build a version from a git ref" accordion already covered thereffield, branch-vs-tag behavior, dev-preview exclusion, and content-root precedence. Added:reforpath, never both;fern checkreports an entry that sets both.fernfolder at the same path at that ref.versionsmetadata).No changelog entry: the feature was already announced in
fern/products/docs/pages/changelog/2026-08-06.mdx("Build a docs version from a git ref"), and these are clarifications to that same feature rather than new capability.Validation:
pre-commit run --files ...(0 errors) andfern check --warnings(0 errors).Link to Devin session: https://app.devin.ai/sessions/83da6c6e72644cb9830d77d87596b053