Repository navigation
feat(docs): move the docs under current/ with URLs unchanged - #383
Conversation
|
Warning Review limit reachedYou've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository. Next included review available in 43 minutes. View limit detailsLimit details: You’ve used the included review currently available. Review configuration: ⚙️ Run configuration
📒 Files selected for processing (34)
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 |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
biggest-littlest
left a comment
biggest-littlest
left a comment
There was a problem hiding this comment.
Docs content moved under current/ with URLs unchanged. 14 required checks and Web Contract green on 3475c7c. Codex reviewed the diff: no blockers, two should-fix findings, both fixed in 582fa6d2 and rechecked. CodeRabbit was out of free reviews.
ALARGECOMPANY
left a comment
ALARGECOMPANY
left a comment
There was a problem hiding this comment.
Docs content moved under current/ with URLs unchanged. 14 required checks and Web Contract green on 3475c7c. Codex reviewed the diff: no blockers, two should-fix findings, both fixed in 582fa6d2 and rechecked. CodeRabbit was out of free reviews.
3 participants
First step of the versioned docs archive for v1.0. The docs content moves under
docs/content/docs/current/so an archived release line can sit beside it later asvX.Y/. No public URL changes.What changed
meta.jsonmove todocs/content/docs/current/. That commit is a pure rename.docs/src/lib/docs-versions.tsgives the Fumadocs loader aslugsfunction that drops thecurrentsegment and takes the rest from Fumadocs' owngetSlugs. A futurevX.Y/directory keeps its segment and serves at/docs/vX.Y/....current/, and so do six prose and comment references.ROADMAP.mdnow says what v1.0 does: archive the v0.9 docs from the final v0.9.x tag.The docs site is a static export, so there are no redirects to lean on. The unversioned URLs are also printed by the binary and the package metadata. That's why
currentstays at/docs/<page>instead of moving to a versioned path the way drydock does.New checks
package-release-config-test.shrequirescurrent/meta.json's title to equal the release'sv<major>.<minor>, with a mutation in the meta-test.scripts/docs-versions.test.mjs: no page outsidecurrent/orvX.Y/, the sitemap and the analytics allowlist each equal the current page set, and every root-relative link resolves inside its own version directory.scripts/docs-export-contract.mjsruns incheck:webafter the build and requires the exported HTML pages to equal the pages incurrent/, in both directions, with an index page.Verification
docs/out/**/*.htmlis identical before and after the move (19 files), and the visible text ofindex.htmlandauthentication.htmlis unchanged.docs/out/current/x.htmland on a missingindex.html.scripts/*-test.shpass. Full pre-push hook passed.One behaviour differs from the Fumadocs default and is noted in the code: a page next to a same-named folder index fails the build as a duplicate slug. Nothing in the tree is laid out that way.