Add version-stable anchors to the release notes template. #111
Conversation
This file contains hidden or 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
The current template embeds anchors from subheadings like "Compiler" that have the same section subheading name; thus, the generated html ends up with `id` attributes that have been uniquified (by adding a incremented suffix, e.g. `#compiler-2`) but those `id` attributes will change (e.g. to `#compiler-3`) as new releases come out. The change in this PR enables one to write urls that end with e.g. `rust-lang#1.66.0-Compiler` and have that url remain usable (in terms of pointing to the compiler subsection *for that release*), even in face of future releases. FYI: in my local experimentation, it appears that in the context of hackmd, visiting an anchor tag with no contents will end up scrolling to a point where the hackmd toolbar obscures the subsection heading. This is unfortunate (though still an improvement on the current state of affairs where one has *no option* to link directly to these subsections in a version-stable manner). I am hoping that there is not a similar problem for the RELEASES.md file when viewed on github itself.
Mark-Simulacrum
approved these changes
Nov 14, 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.
Add version-stable anchors to the release notes template.
The current template embeds anchors from subheadings like "Compiler" that have the same section subheading name; thus, the generated html ends up with
idattributes that have been uniquified (by adding a incremented suffix, e.g.#compiler-2) but thoseidattributes will change (e.g. to#compiler-3) as new releases come out.The change in this PR enables one to write urls that end with e.g.
#1.66.0-Compilerand have that url remain usable (in terms of pointing to the compiler subsection for that release), even in face of future releases.FYI: in my local experimentation, it appears that in the context of hackmd, visiting an anchor tag with no contents will end up scrolling to a point where the hackmd toolbar obscures the subsection heading. This is unfortunate (though still an improvement on the current state of affairs where one has no option to link directly to these subsections in a version-stable manner). I am hoping that there is not a similar problem for the RELEASES.md file when viewed on github itself.