Skip to content

docs: add doc anchor tags#1805

Merged
kian99 merged 6 commits intocanonical:v3from
kian99:add-doc-anchor-tags
Jan 15, 2026
Merged

docs: add doc anchor tags#1805
kian99 merged 6 commits intocanonical:v3from
kian99:add-doc-anchor-tags

Conversation

@kian99
Copy link
Contributor

@kian99 kian99 commented Jan 14, 2026

Description

This PR updates the JAAS CLI reference doc to add anchor tags. These can be used in the MyST markdown format for cross-referencing between pages - see https://myst-parser.readthedocs.io/en/latest/syntax/cross-referencing.html#cross-references.

To update the auto-generated file I've updated our script with a step that runs sed on matching lines. I used an LLM to generate the sed and the commits in this PR show the iterations on how it evolved as I tried to simplify (with some hand tweaks too).

@kian99 kian99 requested a review from a team as a code owner January 14, 2026 15:10
@kian99 kian99 requested a review from tmihoc January 14, 2026 15:10
Copy link
Member

@tmihoc tmihoc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks very nice, thanks!

PS We still need to update the links to use the new anchors. I'll do this in a separate PR tomorrow. (There are a few more little things I want to fix.)

Copy link
Contributor

@ale8k ale8k left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm.

@kian99 kian99 force-pushed the add-doc-anchor-tags branch from 331891b to 0dd18fe Compare January 15, 2026 07:14
@kian99 kian99 merged commit bb628f3 into canonical:v3 Jan 15, 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.

3 participants