canonical / canonical/sphinx-stack

Underscores in anchor

Open
#390 1 comment 0 reactions 0 assignees View on GitHub
good first issue improvement question
Dominant language
No language data
Stars
37
Forks
77
Avg merge
8d 13h
Merged PRs (30d)
5

Description

Is there a reason the anchor defined in [MyST style guide](https://github.com/canonical/sphinx-docs-starter-pack/blob/main/docs/reference/style-guide-myst.md) uses underscores instead of the minus sign (`myst_style_guide`)? Given that

a) Other anchors in the repo (when defined) use the minus char.
b) Sphinx generates the HTML anchor with minus chars, so it's confusing.

Contributor guide

Open the contributing guide

Research direction

Open docs/reference/style-guide-myst.md from the linked MyST style guide and inspect the myst_style_guide anchor alongside other anchors in the repository. Confirm how Sphinx renders the heading, then make the anchor use a minus sign consistently and verify the generated HTML link target.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.