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

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

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

Maintainer thường phản hồi trong vòng 1 ngày

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
Ít trao đổi
Công nghệ
git, yaml
Lĩnh vực
documentation

Hướng nghiên cứu

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.

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

Mô tả

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.
Ngôn ngữ chính
Kotlin
Star
52
Fork
15
Merge trung bình
1 ngày 15 giờ
Pull request đã merge (30 ngày)
36

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

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 SKaiNET-developers/SKaiNET

Tất cả issue của SKaiNET-developers/SKaiNET

Issue tương tự

Thêm issue về Kotlin

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.