DesignSafe-CI / DesignSafe-CI/DS-User-Guide
Can Links Auto-Update When Page Moves?
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- Tcl
- Stars
- 1
- Forks
- 27
- PR merge metrics
- No merged PRs in 30d
Description
Problem
A link to a page must be update if the page is moved.
Upcoming changes (internal project) may move many pages.
Requests
- Links should auto-update if page moves.
- May require new way to write links.
- Should not break existing links.
Ideas
A. Install Plugin
Is there a plugin that can do this?
| plugin | notes | |
|---|---|---|
| ❌ | mkdocs-ezlinks-plugin | not active, not compatible with mkdocs v1.4 |
| 👍 | mkdocs-autorefs | active |
| ❔ |
B. Maintain Redirects
- Install https://github.com/mkdocs/mkdocs-redirects.
- When moving a page, always create a redirect.
C. Program a Solution
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 by reviewing the linked mkdocs-autorefs and mkdocs-redirects projects, then read the referenced MkDocs Material discussion comments. Determine whether the project should adopt a plugin, maintain redirects, or design a new link format while preserving existing links; done means the chosen approach is documented and validated for moved pages.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100