docs: versioned docs per release (/vX.Y/, /latest/, /dev/)
维护者通常 1 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 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
- 平均合并
- 4 小时 15 分钟
- 30 天内合并 PR
- 106
环境准备
在浏览器里用你自己的 GitHub 账号启动这个项目的开发容器。
- 提供 Dockerfile 或 Docker Compose 文件
- 有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 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
-
bug needs triage
难度 2/5 1-3 小时 新手友好度 78/100
netdata/netdata#24062 · 1 条评论 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 76/100
-
难度 2/5 1-3 小时 新手友好度 88/100
riscv-software-src/riscv-isa-sim#2448 ·
维护者通常 2 天内回复
-
难度 2/5 1-3 小时 新手友好度 78/100
-
难度 1/5 1 小时以内 新手友好度 75/100
NabuCasa/silabs-firmware-builder#231 · 1 条评论 ·