Use cross-spec section autolinks instead of absolute URLs #169
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
|
Note I was a bit too prompt to create the PR. The new data has not yet reached the online Bikeshed service that the build code uses to generate the spec. That should happen soon... |
domfarolino
reviewed
Nov 27, 2023
|
I think this should be good to go now, but you probably need to rebase it on top of the new main head for the build to succeed, since when I re-ran it, there was a build failure that I have just now fixed. Could you do that? |
This is purely editorial. The spec had a couple of places where it referenced a section of other specs (RFC9110 and Fetch) using absolute URLs. This update rather uses the recommended cross-spec section autolink: https://speced.github.io/bikeshed/#autolink-biblio This will allow Bikeshed to detect and alert you should the fragment identifiers change in the targeted specifications, as well as to follow the specification if its URL changes (the cross-references database typically now uses the `httpwg.org/specs/` URL for RFC9110 as it is slightly more readable).
Yes, done! I rebased and force-pushed the update. |
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 is purely editorial. The spec had a couple of places where it referenced a section of other specs (RFC9110 and Fetch) using absolute URLs. This update rather uses the recommended cross-spec section autolink: https://speced.github.io/bikeshed/#autolink-biblio
This will allow Bikeshed to detect and alert you should the fragment identifiers change in the targeted specifications, as well as to follow the specification if its URL changes (the cross-references database typically now uses the
httpwg.org/specs/URL for RFC9110 as it is slightly more readable).Preview | Diff