Skip to content

URL fragments referring to internal headings in lowercase#1094

Merged
1 commit merged into
developfrom
unknown repository
Sep 5, 2022
Merged

URL fragments referring to internal headings in lowercase#1094
1 commit merged into
developfrom
unknown repository

Conversation

@ghost

@ghost ghost commented Sep 1, 2022

Copy link
Copy Markdown

Purpose

When it comes to referring to internal anchors, we used a mix of upper and lower cases in our Markdown documents. It appears that Github handles this well, but other Markdown to HTML engines suffer to link to the related identifier on the page since they are looking for a perfect match (case sensitively).
This PR is about downcasing all fragments in our Markdown documents.

Context

n/a

Changes

Downcase all fragments that refer to internal anchors in our Markdown documents.

How to test this PR

Documentation only. Links with the updated fragments should work properly once rendered.

@ghost ghost added this to the v2022.2 milestone Sep 1, 2022
@ghost ghost requested review from matsduf and tgreenx September 1, 2022 14:03

@tgreenx tgreenx left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Fine with me. Template01 gets updated too so it should be fine for future specification updates.

@matsduf

matsduf commented Sep 2, 2022

Copy link
Copy Markdown
Contributor

Maybe Style Guide should be updated too? (There is an open RP on that #1081.)

matsduf added a commit to matsduf/zonemaster that referenced this pull request Sep 2, 2022
@ghost ghost merged commit d925f70 into zonemaster:develop Sep 5, 2022
@ghost

ghost commented Sep 5, 2022

Copy link
Copy Markdown
Author

Maybe Style Guide should be updated too? (There is an open RP on that #1081.)

Good point, I've provided an update of the document in a separate PR, see #1095.

@ghost ghost deleted the header-links-lowercase branch September 5, 2022 10:15
@matsduf matsduf added the A-Documentation Area: Documentation only. label Sep 13, 2022
This pull request was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

A-Documentation Area: Documentation only.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants