Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

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

Open
  • Is something wrong?
#976 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
35/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Quiet
Tech stack
git, yaml
Domain
documentation

Research direction

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.

Written by the indexing model from the issue text.

Description

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.
Dominant language
Kotlin
Stars
52
Forks
15
Avg merge
1d 8h
Merged PRs (30d)
37

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from SKaiNET-developers/SKaiNET

All issues in SKaiNET-developers/SKaiNET

Similar issues

More Kotlin issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.