Skip to content

Avoid using "anchors" block for referencing other specs in Bikeshed #1763

Open

Description

@monica-ch

Per the discussion in #1762 (comment).

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,

  1. Update references to W3C Specs from the "anchors" block with explicitly export definitions.
  2. Use link-defaults for common definitions.

Activity

  1. monica-ch commented on Apr 3, 2025

    @monica-ch
    CollaboratorAuthor
  2. 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
  3. yoshisatoyanagisawa commented on Apr 3, 2025

    @yoshisatoyanagisawa
    Collaborator

    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:

    1. make definitions in W3C specs exported when we use them. At the same time, we remove them from the anchor section.
    2. if there is ambiguity for autolinking, use link-defaults to clarify.
    3. if definitions cannot be exported, we write them down in the "anchors" block.
    4. 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.

    What do you think?

  4. monica-ch commented on Apr 3, 2025

    @monica-ch
    CollaboratorAuthor

    Thanks for writing down the steps in details. Sounds good to me.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions