docs: versioned docs per release (/vX.Y/, /latest/, /dev/)
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 初心者へのやさしさ
- 45/100
- issue の種類
- ドキュメント
- 明瞭さ
- 明確に書かれている
- 活発さ
- 活発
調査の方向性
The docs are in the docs/ directory; the release workflow and build system need changes to publish per-version docs. Start by examining the existing documentation build script (likely a shell script or Makefile) and the GitHub Actions workflow for releases. Understand how the current site is deployed. The goal is to create a structure where each release tag's docs are published under /vX.Y/, /latest/ points to the newest release, and main's docs go to /dev/. This involves versioning the docs, adding version markers to pages, and ensuring old versions remain accessible.
索引モデルが issue の本文から書いたものです。
説明
Problem. The docs site is built from main only. A user on the latest release (v0.43.0) reads docs for whatever is on main, which can describe features, flags or semantics their binary does not have.
What mature languages do. docs.python.org/3.12/, docs.rs//, and pkg.go.dev's version tab all serve each release's docs, with a stable "latest".
Bar.
- Each release tag's
docs/is published under/v<major.minor>/, and/latest/points at the newest release. main's docs are published under/dev/(or equivalent), clearly labelled unreleased. - Every page carries a visible version marker, with a link to the same page in other versions where it exists.
- The release-cut workflow publishes the new version's docs, and the playground is built from the same tag.
- Old versions keep working after a new release (a link check against at least the previous version).
Ranked #5 of the docs follow-ups (2026-09-22 comparison with other languages). Most work; matters most once there are outside users.
- 主要言語
- C
- スター
- 3
- フォーク
- 7
- 平均マージ
- 3時間 58分
- マージ済み PR（30日）
- 105
環境構築
このプロジェクトの開発コンテナを、あなたの GitHub アカウントでブラウザ上に起動します。
- Dockerfile または Docker Compose ファイルあり
- プルリクエストのテンプレートあり
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
InauguralSystems/EigenScript のほかの issue
-
area:lint-tooling bug
難易度 2/5 1〜3時間 初心者へのやさしさ 88/100
InauguralSystems/EigenScript#1340 ·
メンテナーはふだん 1 日以内に返信
-
area:stdlib found-by:code-review kind:silent-wrong
難易度 2/5 1〜3時間 初心者へのやさしさ 88/100
InauguralSystems/EigenScript#1338 ·
メンテナーはふだん 1 日以内に返信
-
area:lint-tooling found-by:critic kind:docs-drift
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
InauguralSystems/EigenScript#1335 ·
メンテナーはふだん 1 日以内に返信
-
area:ci found-by:critic kind:gate-defect
難易度 2/5 1〜3時間 初心者へのやさしさ 86/100
InauguralSystems/EigenScript#1311 ·
メンテナーはふだん 1 日以内に返信
-
enrolment: decide test_gc_runner_controls.py (exempt vs enrol) and whether floors need a ratchetオープンarea:gates found-by:critic kind:decision
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
InauguralSystems/EigenScript#1280 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
InauguralSystems/EigenScript の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
-
難易度 1/5 1時間未満 初心者へのやさしさ 75/100
NabuCasa/silabs-firmware-builder#231 · コメント 1 件 ·
-
難易度 1/5 1〜3時間 初心者へのやさしさ 88/100
ClickHouse/pg_clickhouse#383 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
メンテナーはふだん 1 日以内に返信