Fix three broken heading anchors in operator and onboarding docs - #27927
Draft
jessiemongeon1 wants to merge 1 commit into
Draft
Fix three broken heading anchors in operator and onboarding docs#27927jessiemongeon1 wants to merge 1 commit into
jessiemongeon1 wants to merge 1 commit into
Conversation
A checker comparing every `#fragment` link against the headings on its target page found three links pointing at anchors that do not exist. Each silently drops the reader at the top of the page instead. - `libpq-req.mdx` linked to `#start-the-local-network`. The heading is "Starting the local network", so the slug is `#starting-the-local-network`. - `sui-full-node.mdx` linked to `#pruning-quickstart` on `managing-data`. That page has no quickstart section; the relevant heading is `#pruning`. The link is in a troubleshooting row for a full disk, so the pruning section is the right destination. - `snapshots.mdx` linked to `#rocksdb-buckets` on `available-data-stores`. That page documents checkpoint stores and formal snapshot stores only, and no page lists RocksDB bucket names, so the sentence promised a list that does not exist anywhere. Dropped the dead link rather than pointing it somewhere unrelated. Also removed a trailing space from the "Pruning" heading in `managing-data.mdx` so the slug does not depend on the generator trimming it.
jessiemongeon1
deployed
to
sui-typescript-aws-kms-test-env
September 8, 2026 23:33 — with 
GitHub Actions
Active
GitHub Actions
Active
|
The latest updates on your projects. Learn more about Vercel for GitHub.
2 Skipped Deployments
|
github-actions
Bot
added
the
Type: Documentation
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.
Description
Three
#fragmentlinks point at anchors that do not exist on their target pages, so they drop the reader at the top of the page with no indication anything went wrong. Docusaurus does not validate fragments, so the strict build does not catch these.One is a content gap rather than a typo:
snapshots.mdxpromised a list of RocksDB snapshot bucket names onavailable-data-stores, but that page documents checkpoint stores and formal snapshot stores only, and no page in the docs lists RocksDB bucket names (snapshots.mdxitself uses<BUCKET_NAME>placeholders). I removed the dead link rather than redirect it somewhere unrelated. If those bucket names should be published, that is worth a follow-up.Test plan
Found with a checker that resolves every
#fragmentlink indocs/contentagainst the headings of its target page. After the fix, the only remaining reports are 9 links into generated framework reference pages, which declare anchors as<h2 id="...">HTML rather than markdown headings; I spot-checked those against the rendered pages and they resolve correctly.Release notes
Check each box that your change affects. If none of the boxes relate to your changes, release notes aren't required.
For each box you select, include information after the relevant heading that describes the impact of your changes.