Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Versioned docs: a version switcher, main plus each release

Đang mở
  • Có gì không ổn?
#289 2 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
35/100
Loại issue
Tính năng
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
nuxt, typescript
Lĩnh vực
documentation

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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.0 and main. The default branch is 4.3, where most fixes land before they're merged forward.
  • Symfony (symfony/symfony-docs): branches 2.0 … 8.2. The default is 7.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. A versionadded note 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, …), plus main. Before 2.0.0 there's one prerelease line: main and latest (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.txt and the quiz: search should cover the selected version, and llms.txt the 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 main when 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?).

Ngôn ngữ chính
TypeScript
Star
0
Fork
0
Merge trung bình
1 giờ 20 phút
Pull request đã merge (30 ngày)
1

Chuẩn bị môi trường

Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của components-web-app/docs

Tất cả issue của components-web-app/docs

Issue tương tự

Thêm issue về TypeScript

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.