Hacktoberfest 2026：メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

Versioned docs: a version switcher, main plus each release

オープン
  • 何か問題がありますか？
#289 コメント 2 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
35/100
issue の種類
機能追加
明瞭さ
おおむね明確
活発さ
活発
技術スタック
nuxt, typescript
領域
documentation

調査の方向性

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.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?).

主要言語
TypeScript
スター
0
フォーク
0
平均マージ
1時間 20分
マージ済み PR（30日）
1

環境構築

このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

components-web-app/docs のほかの issue

components-web-app/docs の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。