You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Avoid using "anchors" block for referencing other specs in Bikeshed #1763
The current use of the "anchors" block in the Bikeshed file to reference definitions from other specifications (e.g., HTML, Fetch, Storage) is problematic. So,
Update references to W3C Specs from the "anchors" block with explicitly export definitions.
changed the title [-]Avoid Using "anchors" Block for Referencing Other Specs in Bikeshed[/-][+]Avoid using "anchors" block for referencing other specs in Bikeshed[/+]on Apr 3, 2025
My take away is different.
I understand it is recommended to explicitly export definitions in W3C specs. Therefore, I thought what @mkruisselbrink concerned in #1762 (comment) was that we are adding definitions for W3C specs in the anchor section. Therefore, definitions that cannot be in the autolinking database might be fine to be shown up in the anchor section. (Yeah, we will send PRs to specs to export definitions the ServiceWorker spec uses beforehand to make them stored in the autolinking database)
Then, I thought our steps might be:
make definitions in W3C specs exported when we use them. At the same time, we remove them from the anchor section.
if there is ambiguity for autolinking, use link-defaults to clarify.
if definitions cannot be exported, we write them down in the "anchors" block.
if it is not definitions, maybe directly link there. (Do we prefer a mark-down style ([word](https://example.com/)) to an HTML style (<a href="/?url=https%3A%2F%2Fexample.com%2F">word</a>) ?)
We should be sure that bikeshed won't warn for broken link made by 3. and 4.
Activity
monica-ch commentedon Apr 3, 2025
cc @yoshisatoyanagisawa
[-]Avoid Using "anchors" Block for Referencing Other Specs in Bikeshed[/-][+]Avoid using "anchors" block for referencing other specs in Bikeshed[/+]yoshisatoyanagisawa commentedon Apr 3, 2025
My take away is different.
I understand it is recommended to explicitly export definitions in W3C specs. Therefore, I thought what @mkruisselbrink concerned in #1762 (comment) was that we are adding definitions for W3C specs in the anchor section. Therefore, definitions that cannot be in the autolinking database might be fine to be shown up in the anchor section. (Yeah, we will send PRs to specs to export definitions the ServiceWorker spec uses beforehand to make them stored in the autolinking database)
Then, I thought our steps might be:
[word](https://example.com/)) to an HTML style (<a href="/?url=https%3A%2F%2Fexample.com%2F">word</a>) ?)We should be sure that bikeshed won't warn for broken link made by 3. and 4.
What do you think?
monica-ch commentedon Apr 3, 2025
Thanks for writing down the steps in details. Sounds good to me.