docs: pin every moving reference in a frozen version - #46
Merged
Merged
Conversation
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Advanced Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Signed-off-by: suiramdev <me@suiram.dev>
suiramdev
force-pushed
the
docs/pin-moving-refs
branch
from
September 22, 2026 14:06
e0a397c to
1a32b11
Compare
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
A frozen documentation version must not point readers at anything that moves. The snapshot script already pinned repository links and
FREENARY_VERSIONlines, but not thecurlURLs that install the stack, so0.1told its readers to downloaddocker-compose.ymland.env.examplefrommain. This lifts the three moving forms into oneMOVING_REFStable that the writer (snapshot-version.ts) and the gate (check-docs.ts) both read, adds the download URL as the third form, and backfills the two frozen0.1pages. Look atapps/fumadocs/scripts/moving-refs.tsfirst.Motivation
0.1was handedmain's compose file to run against0.1images.0.1/self-hosting/index.mdxstill claimed the registry holds nolatesttag;images.ymlhas publishedlatestsincev0.1.0, and four sibling pages in that same folder already said so.Drawbacks
0.1folder is edited, which the docs rules normally forbid. Both edits make0.1pages describe0.1instead ofmain, so they fall under the correction-to-that-release exception — but they deserve a deliberate look.docs/engineering/platform.mdrecords the hazard and the workaround.Prior art
FREENARY_VERSIONpin already existed separately ondev; this is their generalisation, and both keep their rule names and messages verbatim.bashfence with no stable syntactic marker, andcurl -Ois not the only way to write it.Notes
apps/fumadocscarries none.next/contributing/releasing.mdx,next/contributing/writing-docs.mdx,next/self-hosting/index.mdx,apps/fumadocs/AGENTS.md,docs/engineering/platform.md, plus the0.1corrections.docs:checkgreen (76 pages, 0 errors),bun run buildexit 0,oxlint,tsc --noEmitandultracite checkclean. A throwawaydocs:snapshot 9.9.0produced a folder the gate passes with 0 errors, and injected moving references in frozen pages are each reported at the correct line.revieweragent: approved, no findings.