Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Use H2 for headings in Annex A #988

Merged
merged 4 commits into from
Jul 22, 2024
Merged

Use H2 for headings in Annex A #988

merged 4 commits into from
Jul 22, 2024

Conversation

bact
Copy link
Collaborator

@bact bact commented Jul 10, 2024 •
edited
Loading

Fix Markdown issues in docs/annexes/diffs-from-previous-editions.md:

  • Use H2 instead of H1 for top headings, so readthedocs theme can generate proper navigation (H1 is reserved for a title in Markdown) (see screenshots below)
  • Add missing leading/trailing pipes for tables
  • Remove extra column for BUILD_DEPENDENCY_OF
  • Add missing strike-through markup for PREREQUISITE_FOR

Before fix:
Screenshot 2024-07-10 at 11 43 41

After fix:
Screenshot 2024-07-10 at 11 45 06

Similar fix for v2.3 in #983

bact added 2 commits July 10, 2024 23:59
@bact
[3.0] Use H2 for headings in Annex A to fix nav bar issue
70bdfa8 
Replace H1 with H2 headings, to allow mkdocs/readthedocs to generate proper heading items in navigation bar.

Signed-off-by: Arthit Suriyawongkul <[email protected]>
@bact
Put together text portions from the same bullet
d374e2d 
Signed-off-by: Arthit Suriyawongkul <[email protected]>
This was referenced Jul 10, 2024
Merged
Closed
@zvr zvr requested a review from goneall July 16, 2024 09:07
@zvr zvr added this to the 3.0.1 milestone Jul 16, 2024
@zvr zvr changed the title [3.0] Use H2 for headings in Annex A to fix nav bar issue Use H2 for headings in Annex A Jul 16, 2024
goneall
goneall approved these changes Jul 22, 2024
View reviewed changes
Copy link
Member

@goneall goneall left a comment

Choose a reason for hiding this comment

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

LGTM

kestewart
kestewart approved these changes Jul 22, 2024
View reviewed changes
Copy link
Contributor

@kestewart kestewart left a comment

Choose a reason for hiding this comment

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

Nice job on cleaning up headings, bullets and tables.

@kestewart kestewart merged commit 293b880 into spdx:development/v3.0.1 Jul 22, 2024
3 checks passed
@bact bact deleted the fix-h1-diff-versions-v3.0 branch July 22, 2024 22:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@goneall goneall goneall approved these changes

@kestewart kestewart kestewart approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
3.0.1
Development

Successfully merging this pull request may close these issues.
4 participants
@bact @goneall @kestewart @zvr