Repository navigation
docs: fix stale API anchors in the v11 upgrade guide - #4563
Open
guitarmanchan911-byte wants to merge 1 commit into
Open
guitarmanchan911-byte wants to merge 1 commit into
guitarmanchan911-byte wants to merge 1 commit into
Conversation
The upgrade guide points at two anchors on the API docs page that no longer exist, so the links land at the top of the page instead of the function docs: - api.html#highlight-all -> #highlightall - api.html#highlight-element -> #highlightelement Both old anchors are absent from the rendered page (https://highlightjs.readthedocs.io/en/latest/api.html), while the two replacements are present and match the documented function names. docs/upgrade-11.md is a symlink to this file, so the docs site picks the change up automatically. Assisted-by: Codex (GPT-5)
This branch has not been deployed
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
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.
Changes
The v11 upgrade guide links to two anchors on the API documentation page that no longer exist, so both links land at the top of the page instead of at the function docs:
api.html#highlight-all->#highlightallapi.html#highlight-element->#highlightelementVerified against the rendered page (https://highlightjs.readthedocs.io/en/latest/api.html): it contains
id="highlightall"andid="highlightelement", and no occurrence ofhighlight-allorhighlight-element. The sidebar on that page uses the same two anchors, so this just matches the docs as they are today.docs/upgrade-11.mdis a symlink toVERSION_11_UPGRADE.md, so the docs site picks the change up from the one file.Scope note: while checking this I found one more stale link of the same kind —
CHANGES.mdpoints athighlightjs.readthedocs.org/.../style-guide.html, which 404s (that page is nowlanguage-contribution.html). I left it out since CHANGES.md is a historical changelog; say the word if you would prefer it in this PR or in a separate one.Checklist
Assisted-by: Codex (GPT-5)