Add infrastructure to redirect anchors
Nobody has claimed this yet.
- Dominant language
- Nix
- Stars
- 4k
- Forks
- 339
- Avg merge
- 2d 11h
- Merged PRs (30d)
- 7
Description
Problem
When we move sections from one file to another, there is no way to automatically redirect users to the new location. Using stale anchor links will lead nowhere.
Approaches
The Nix manual uses a client-side redirect script we could copy.
It should be easy to incorporate it into the site configuration.
There doesn't seem to be comparable pre-made tooling for Sphinx, judging from a quick internet search.
Willing to help?
Always.
Priorities
Add 👍 to issues you find important.
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 Nix manual's linked redirects.js and the site's configuration. Investigate how the Sphinx-generated documentation exposes anchors and how a redirect mechanism could be incorporated there. Done means stale anchors from moved sections resolve to their new locations, with behavior that can be verified from the generated site.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100