speced / speced/respec

Provide a way to maintain old element ids

Open
#5,327 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Feature request
Dominant language
JavaScript
Stars
806
Forks
434
Avg merge
1d 21h
Merged PRs (30d)
32

Description

Is your feature request related to a problem? Please describe.

https://github.com/w3c/sustainableweb-wsg/pull/338#issuecomment-4594819086 reports that some ID attributes changed, which might break existing inbound links.

Describe the solution you'd like

Bikeshed allows an oldids attribute on heading elements, to cause the old IDs to point there. Presumably Respec will use data-oldids instead.

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 linked Bikeshed id-gen documentation and the referenced W3C issue comment to understand how old IDs should preserve inbound links. Then locate Respec's heading ID generation and verify the behavior for both oldids and data-oldids; done means prior IDs resolve to the updated heading without changing normal ID generation.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
56/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.