Add anchors to all terms of the glossary #38073
Merged
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
oandregal
requested review from
a team and
aristath
and removed request for
a team
oandregal
changed the title
aristath
approved these changes
Jan 19, 2022
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.
This PR makes all words in the glossary linkable, so they're easier to share and so gain wider visibility.
Implementation
I've made them all h2 headings because of how the handbook works: it automatically adds a link to the headings, see the FAQ section as an example.
Alternatively, I could have added
id="title-of-section"to the existing DT items. However, this is prone to human errors (typos, people forgetting to add the id, etc). The fact that only one of the terms already had ID should speak about this. Embracing the existing native handbook structure seems more future-proof.