Hacktoberfest 2026：维护者为十月标记出来的 issue，仍然开放、适合新手。 浏览 Hacktoberfest issue

Antora docs site has no version selector — pin per release instead of a single unversioned component

未关闭
  • 哪里不对？
#976 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
5/5
预计耗时
一周以上
新手友好度
35/100
Issue 类型
功能
描述清晰度
基本清楚
活跃度
冷清
技术栈
git, yaml
领域
documentation

调研方向

Read docs/antora.yml and antora-playbook.yml to understand the current component version and content sources; first resolve the versioning and tag-retention policy described in the issue. Done means the site exposes selectable release versions alongside develop, with the chosen default and release-update process defined. #975 must be fixed separately for the site to deploy.

由索引模型根据 Issue 内容生成。

描述

Summary

`docs/antora.yml` declares `version: ~` — Antora's syntax for an explicitly
unversioned component. The published site (once #975 is also fixed so it deploys
at all) only ever shows one snapshot of the docs, with no way to view the docs as they
were for an older release (e.g. 0.39.x) versus current `develop`. The workflow's own
comment acknowledges this is deliberate scope-narrowing: "Single-version for now; a
dedicated multi-repo aggregation site can come later."

This matters concretely for this session's work: SKEEP-002/003 landed on `develop`
and are reachable from tag `0.40.1`, but a reader on the live site has no way to know
"is this SKEEP status current as of the latest release, or has it moved since." Same
class of problem applies to any API/behavior doc that changes between releases.

Proposed direction (not prescriptive — Antora supports several shapes here)

Antora has first-class multi-version support: each content source
(playbook `content.sources`) can point at multiple git refs (branches/tags), and each
ref's `antora.yml` `version:` becomes a selectable entry in the generated version
dropdown, with the highest `display_version`/`prerelease: false` version becoming the
default landing page.

Sketch:

  1. Set `version:` in `docs/antora.yml` per release (e.g. `version: '0.40'`,
    `display_version: '0.40.1'`) instead of `~`, updated as part of the existing
    `release: prepare X.Y.Z` commit pattern (SKaiNET-transformers already has this
    commit type; mainline doesn't yet but could adopt it, or just bump the antora.yml
    version field wherever the version bump currently happens).
  2. `antora-playbook.yml`'s `content.sources` adds tag refs (e.hg. `tags: 0.39., 0.40.`
    or an explicit allowlist) alongside `branches: develop`, so Antora builds one page
    tree per historical version from the tagged source at that point in time.
  3. Decide a retention policy (all tags forever vs. last N minor versions) — full
    history multiplies build time and site size per version.

Related

  • #975 — the site currently doesn't deploy at all (gated on a GitHub Release this
    repo never creates); fix that first, independent of this.
  • The same `version: ~` pattern exists in SKaiNET-transformers' `docs/antora.yml`
    (same Docker image, same Antora setup) — filing a companion issue there rather than
    scoping this one cross-repo, since the playbooks/CI are maintained separately.
主要语言
Kotlin
星标
52
派生
15
平均合并
1 天 15 小时
30 天内合并 PR
36

环境准备

  • 没有 Dockerfile 或 Docker Compose 文件
  • 没有 Pull Request 模板
  • 阅读贡献指南

从这里开始

  1. 先读完整个 Issue，再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库，在一个分支上完成修改。
  4. 提交 Pull Request，并在描述里引用这个 Issue 编号。

SKaiNET-developers/SKaiNET 的其他 Issue

查看 SKaiNET-developers/SKaiNET 的全部 Issue

相似的 Issue

更多 Kotlin Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。