Skip to content

tabbed-nav: carry each version's selector text (Current, LTS) into docsets.json - #160

Merged
recrwplay merged 2 commits into
devfrom
feature/tabbed-nav-selector-text
Oct 23, 2026
Merged

recrwplay merged 2 commits into
devfrom
feature/tabbed-nav-selector-text

Conversation

@recrwplay

Copy link
Copy Markdown
Contributor

Bumps @neo4j-antora/tabbed-nav from 0.4.1 to 0.4.2.

What

Each version in docsetVersions (on a component's latest tabs.json entry) now carries selectorText, and docsets.json passes it through to each version:

{ "version": "2026.11", "latest": true, "selectorText": "(Current) (LTS)", "url": "/cypher-manual/2026.11/", "pdf": "..." }

selectorText is the text the page's version selector shows after the version. The selector-labels extension sets it on each component version: (Current) for the latest version, (LTS) for a version marked lts: true in antora.yml, or both. The docsets modal in docs-ui (docs-restructure) uses it so it shows the same markers as the page, including LTS, which it could not show before.

  • It is '' when a version has no marker, and absent for a docset that has not been built since this change, so a consumer can tell the two apart. The modal falls back to (Current) for the latest version when the field is absent.
  • It relies on selector-labels having run before tabbed-nav. The docs build adds tabbed-nav last, so it should have.

Testing

  • The docsets.js merge was checked on sample data: a rebuilt docset keeps selectorText (including ''), and an older one has no such field.
  • Not tested: a full Antora build with selector-labels and tabbed-nav together, so the ordering above is not confirmed against a real build.

Rollout

  • The aggregator in docs-publish already installs the latest tabbed-nav (neo4j/docs-publish#37), so it needs no change.
  • A docset only gains the field when it is next built with this version.

Follow-up

Document selectorText, along with docsets.json and its attributes, in the docs-playbook tabbed-nav page, from main.

…csets.json

selector-labels sets selectorText on a component version, which the page's
version selector shows after the version. Include it in each docsetVersions
entry and pass it through to docsets.json, so the docsets modal can show the same
markers as the page. Absent for a docset not built since, so a consumer can tell.
@neo4j-docops-agent

neo4j-docops-agent commented Oct 23, 2026 •

Copy link
Copy Markdown
Collaborator

Thanks for the documentation updates.

The preview documentation has now been torn down - reopening this PR will republish it.

@recrwplay
recrwplay merged commit 2055e54 into dev Oct 23, 2026
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants