[2.3] Use H2 for headings in Annex I (diff from prev editions) to fix nav bar issue #983
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
To allow readthedocs to generate proper heading items in the navigation bar. In Markdown, H1 is reserved for the title. readthedocs theme will read only H2 headings to generate expandable items in the nav bar. There is no change in the content. Signed-off-by: Arthit Suriyawongkul <[email protected]>
This was referenced Jul 8, 2024
zvr
approved these changes
Jul 29, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
To allow readthedocs to generate proper heading items in the navigation bar.
Currently when a user clicked on the page https://spdx.github.io/spdx-spec/v2.3/diffs-from-previous-editions/ ,
the nav bar on the left will not expanding the subheadings. This is behavior is different from other chapters/annexes.
The reason is, in Markdown, H1 is reserved for the title.
mkdocs's readthedocs theme will read only H2 headings to generate expandable items in the nav bar.
This fix add one level to all headings in the doc (H1 -> H2), except the title.
There is no change in the content.
See screenshot of a similar fix (for 3.0) in #988