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.

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

Make definition anchors more unique #1339

Merged
merged 2 commits into from Nov 15, 2022
Merged

Conversation

richvdh
Copy link
Member

@richvdh richvdh commented Nov 15, 2022

Stick a definition- on the front of the autogenerated anchors for definition blocks.

This solves a problem where, for example, https://spec.matrix.org/unstable/application-service-api/#registration could refer to either the "Registration" section or the Registration definition therein.

(These anchors are relatively recent: they were added in #1191.)

Preview: https://pr1339--matrix-spec-previews.netlify.app

Stick a `definition-` on the front of the autogenerated anchors for definition
blocks.

This solves a problem where, for example,
https://spec.matrix.org/unstable/application-service-api/#registration could
refer to either the "Registration" section or the `Registration` definition
therein.

(These anchors are relatively recent: they were added in #1191.
@richvdh richvdh requested a review from a team as a code owner November 15, 2022 17:14
Copy link
Member

@anoadragon453 anoadragon453 left a comment

Choose a reason for hiding this comment

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

Note that this will break old (unstable) links. Though considering the original id was only added relatively recently, and that there's no easy user-facing method of generating these links yet, I don't believe the breaking change will affect many, if anyone.

@richvdh richvdh merged commit bc15d4f into main Nov 15, 2022
@richvdh richvdh deleted the rav/better_definition_anchors branch November 15, 2022 19:15
clokep pushed a commit to clokep/matrix-spec that referenced this pull request May 3, 2023
Stick a `definition-` on the front of the autogenerated anchors for definition
blocks.

This solves a problem where, for example,
https://spec.matrix.org/unstable/application-service-api/#registration could
refer to either the "Registration" section or the `Registration` definition
therein.

(These anchors are relatively recent: they were added in matrix-org#1191.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants