Versioned docs: a version switcher, main plus each release
还没有人认领这个 Issue。
评估
- 难度
- 5/5
- 预计耗时
- 一周以上
- 新手友好度
- 35/100
- Issue 类型
- 功能
- 描述清晰度
- 基本清楚
- 活跃度
- 活跃
- 技术栈
- nuxt, typescript
调研方向
Start by reading the docs site's Nuxt Content configuration and its Vercel prerender setup to see how content collections and routes are built. The issue leaves hosting and the first version branch timing undecided, so those decisions need to be resolved before implementation. Done means readers can switch versions, land on the latest release by default, and find matching pages across versions while search and the quiz use the selected or specified version.
由索引模型根据 Issue 内容生成。
描述
Daniel (2026-10-21): the docs should have versions you can switch between. One version is main, the docs for the release being prepared. The default is the latest release. Later, every release keeps its own docs, so readers can look back at older versions.
How API Platform and Symfony do it
Both keep the docs in their own repo, with one branch per minor version, and the site has a version switcher.
- API Platform (api-platform/docs): branches
1.0…4.4,5.0andmain. The default branch is4.3, where most fixes land before they're merged forward. - Symfony (symfony/symfony-docs): branches
2.0…8.2. The default is7.4, the LTS. Contributors target the oldest maintained branch a change applies to, and maintainers merge it up. URLs carry the version (/doc/7.4/…), and/doc/current/points to the latest stable. Aversionaddednote marks what a version added.
For CWA
- Version scheme: the three projects share 2.0.0 from the beta, and the template and create-cwa share one version. So the docs could branch per CWA minor (
2.0,2.1, …), plusmain. Before 2.0.0 there's one prerelease line:mainandlatest(the newest alpha or beta). - Building: the site is prerendered to Vercel. Options are a separate deploy per branch on a subdomain or path, or one build that renders each branch's
content/under/<version>/. Nuxt Content can take more than one collection from a git source. - Default and switcher:
/and unversioned links go to the latest release, and a header select switches version. Links between versions keep the path when the page exists. - Search,
llms.txtand the quiz: search should cover the selected version, andllms.txtthe latest. The quiz is pinned to doc sections by hash, so it needs one version, probably the latest. - Markers: keep
*Since [template 2.0.0-alpha.N](…)*. In a version's own branch,on main after …notes become release notes or drop out. - Process: document a change on
mainwhen it lands (as now). When a release is cut, branch or tag the docs, and backport fixes to the latest release branch.
Not started. Needs a decision on hosting, and on when to cut the first version branch (at the beta?).
- 主要语言
- TypeScript
- 星标
- 0
- 派生
- 0
- 平均合并
- 1 小时 20 分钟
- 30 天内合并 PR
- 1
环境准备
这个项目没有提供开发容器、Dockerfile 或贡献指南，环境需要你自己搭建：先看它的 README，通用步骤见我们的新手贡献指南。
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
components-web-app/docs 的其他 Issue
-
难度 3/5 1-2 天 新手友好度 67/100
components-web-app/docs#294 · 1 条评论 ·
-
documentation
难度 4/5 3-5 天 新手友好度 45/100
components-web-app/docs#290 ·
-
documentation
难度 4/5 3-5 天 新手友好度 43/100
components-web-app/docs#285 ·
-
documentation
难度 4/5 1-2 天 新手友好度 35/100
components-web-app/docs#284 ·
-
enhancement
难度 5/5 一周以上 新手友好度 15/100
components-web-app/docs#237 · 2 条评论 ·
查看 components-web-app/docs 的全部 Issue
相似的 Issue
-
bug P3 UI/UX
难度 2/5 1-3 小时 新手友好度 78/100
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 78/100
StellarState/SS-backend#712 ·
维护者通常 1 天内回复
-
area: backend bug
难度 2/5 1-3 小时 新手友好度 78/100
snapotter-hq/SnapOtter#3473 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 82/100
gitroomhq/postiz-app#2304 ·
维护者通常 1 天内回复
-
harlan-agent-ready-to-implement routine:ci-review
难度 2/5 1-3 小时 新手友好度 72/100
harlan-zw/unlighthouse#454 · 2 条评论 ·
维护者通常 1 天内回复