-
Notifications
You must be signed in to change notification settings - Fork 127
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
Add search role’s base concept pointing to HTML spec. Fix #1898 #1900
Add search role’s base concept pointing to HTML spec. Fix #1898 #1900
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM. 👍🏻 I find the direct link helpful, but I also don’t know why there are differing conventions in the spec. Maybe it’d be good to normalize those, as a separate issue? /cc @spectranaut
I honest don't think I'm the best person to ask -- but maybe our links do need auditing/normalizing/fixing, maybe an issue could be filed? :) I think an editor, @jnurthen should way in on the linking decision here :) |
A PR to clean up the others to use either xref (if possible) or data-cite (if no reasonable xref exists) would be great! |
jnurthen marked as non substantive for IPR from ash-nazg. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
i suggest we go with @jnurthen's second suggestion of using xref - [^search^]
lgtm otherwise
Co-authored-by: James Nurthen <[email protected]>
👍 thank you all for the feedback, this is my first time using ReSpec so very much appreciated. I’ve updated the PR accordingly. |
Co-authored-by: James Nurthen <[email protected]>
Claiming #1898 – with a link directly to the HTML spec.
Couple of things I noted along the way that informed this task, however small:
<code><button></code> in [[HTML]]
, with "HTML" being an inline reference pointing to the doc’s Normative references section. I found the direct links more helpful so chose that.https://www.w3.org/TR/html5/grouping-content.html
) to the HTML spec as other Base Concept links for consistency, but this URL 307-redirects to the WHATWG living standard athttps://html.spec.whatwg.org/multipage/grouping-content.html
. It’d be nice to avoid this redirect but felt consistency mattered more, though the HTML link in "Normative references" also points to the WHATWG multi-page spec.I’ll happily revisit this if it’s better to use the no-direct-link reference for consistency. And clean up other definitions as a separate PR if it helps.
Diff