[TASK] Document anchor persistence rule - #537
Merged
Merged
Conversation
Removing content without a redirect has confused users who had an old link bookmarked or indexed by a search engine. Document the site-intercept redirect process for official TYPO3 documentation repositories (anyone can open a PR there, not just maintainers) -- explicitly out of scope for individual extension docs, since it doesn't scale to a PR per extension per rename. Includes the Documentation/404.rst pattern for deleted-with-no- replacement content, using the real 404.rst in TYPO3CMS-Reference-CoreApi as a concrete example. Verified against the actual site-intercept repo (file path, default branch, and URL pattern all confirmed) and with the full Docker render pipeline. Assisted-by: Claude Sonnet 5 <[email protected]> Signed-off-by: Lina Wolf
An anchor is a promise: once a page containing it has reached main, the anchor must keep working, even after the heading it was on is gone. Document what to do instead of deleting it (move to the covering heading, or into Documentation/404.rst for removed concepts), referencing the redirects guide for the full pattern. Unlike the redirects process itself, this rule applies to anyone writing TYPO3 documentation, not just official repositories. Also notes that malformed anchor lines silently fail instead of erroring, which is easy to miss. Verified with the full Docker render pipeline. Assisted-by: Claude Sonnet 5 <[email protected]> Signed-off-by: Lina Wolf
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Depends on #536 — this PR is based on
docs/renaming-deleting-pagesand its:ref:redirects`` link only resolves once that page exists. Please merge #536 first (or into it), then rebase/retarget this PR ontomain.An anchor is a promise: once a page containing it has reached main,
the anchor must keep working, even after the heading it was on is
gone. Document what to do instead of deleting it (move to the
covering heading, or into Documentation/404.rst for removed
concepts), referencing the redirects guide for the full pattern.
Unlike the redirects process itself, this rule applies to anyone
writing TYPO3 documentation, not just official repositories.
Also notes that malformed anchor lines silently fail instead of
erroring, which is easy to miss.
Verified with the full Docker render pipeline.
Assisted-by: Claude Sonnet 5 [email protected]
Signed-off-by: Lina Wolf