getodk / getodk/docs

JS redirect solution for anchor links

Open
#643 5 comments 0 reactions 0 assignees View on GitHub
coding
Dominant language
Python
Stars
58
Forks
160
Avg merge
5d 11h
Merged PRs (30d)
12

Description

When a section title is changed it breaks anchor links.
(Note, this has to do with the actual title of the section, not the in=sphinx section reference name.)

We can't fix this server side (anchor links are handled on the client).
It would be good to have some kind of anchor link redirect feature,
with a simple mapping file that content authors can update if they re-title a section.

Contributor guide

Open the contributing guide

Research direction

Start by locating the client-side anchor-link handling in the Sphinx-built documentation and determine where a mapping file could be loaded. Define the redirect behavior for renamed section-title anchors and verify that old links reach the corresponding sections.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.