WordPress / WordPress/Documentation-Issue-Tracker
@wordpress/data readme broken links
Nobody has claimed this yet.
- Dominant language
- Shell
- Stars
- 109
- Forks
- 73
- PR merge metrics
- No merged PRs in 30d
Description
Issue Description
There are two broken links in the readme for the block editor data package. The links do not match the casing of their destinations, causing the link to have no effect.
URL of the Page with the Issue
https://developer.wordpress.org/block-editor/reference-guides/packages/packages-data/
Section of Page with the issue
The useRegistry entry has a link to the RegistryProvider. The document fragment link is #RegistryProvider whereas the registry provider entry has an id of #registryprovider.
In the RegistryProvider entry there is the same issue linking to RegistryConsumer. The document fragment link is #RegistryConsumer but the entry has the id #registryconsumer.
Why is this a problem?
This is a problem because clicking the link does not lead to the correct entry. Instead, the page stays at the current item.
Suggested Fix
Update the links to match their destination id. The API documentation part of the document is auto-generated, indicated by the <!-- START TOKEN(Autogenerated API docs) --> comment.
I am interested in creating a PR to fix these links, but I would need a bit of guidance to track down where the automation for these API methods is implemented.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the linked block editor data package page and the autogenerated API documentation section. Trace the source for the useRegistry, RegistryProvider, and RegistryConsumer entries, then verify that each fragment link uses the destination's lowercase id. Done means both links navigate to the correct entries.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100