w3c / w3c/ServiceWorker

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

Open
#1,763 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Bikeshed
Stars
3.6k
Forks
324
Avg merge
14d 22h
Merged PRs (30d)
1

Description

Per the discussion in https://github.com/w3c/ServiceWorker/pull/1762#discussion_r2012635371.

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.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the Bikeshed file and the discussion in pull request 1762, then identify the current anchors used for HTML, Fetch, Storage, and other W3C definitions. Replace those references with explicitly exported definitions and link-defaults for common definitions; the work is done when the specification builds with the updated references.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Refactor
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.