Skip to content

fix/links: Fix broken heading links (28 reworded, code search & navigation) - #1870

Open
marcleblanc2 wants to merge 1 commit into
mainfrom
fix-reworded-anchors-search-nav
Open

fix/links: Fix broken heading links (28 reworded, code search & navigation)#1870
marcleblanc2 wants to merge 1 commit into
mainfrom
fix-reworded-anchors-search-nav

Conversation

@marcleblanc2

@marcleblanc2 marcleblanc2 commented Sep 7, 2026

Copy link
Copy Markdown
Contributor

Linear FE-499: Fix doc site issues

Smaller, more easily reviewed subset of fixes from #1861

#anchor links under docs/code-search/ and docs/code-navigation/ whose target heading was reworded. The section still exists; the link now uses the current heading's slug.

Review: for each row, the new heading should be the same topic as the old anchor's words. Rows where the heading was replaced rather than renamed (e.g. several anchors collapsed onto one #configuration or #upgrade-types section) are the ones worth a second look.

Most rows are docs/code-navigation/auto-indexing-configuration.mdx, whose field headings dropped their index-job- / docker-step- prefixes. One to note there: #docker-step-root#root-1, because the page has both an index-job root and a docker-step root heading and github-slugger numbers the second.

Checker findings (npm run check-links -- --check-anchors, from #1858, with its heading-slug fix): 278 on main → 250 on this branch.

Verification

The docs site serves its not-found page with HTTP 200 (fix in progress), so status codes prove nothing. Instead, every changed link was fetched on this PR's Vercel preview and the rendered HTML checked for two ids: the target page's own first heading (taken from its MDX source — the 404 page never has it) and the link's #fragment. Script: node dev/verify-links-live.mjs --site <preview-url>, coming in #1858.

Old links point at the current production site so you can see the breakage; new links point at the preview and land on the heading.

Checked 28 changed links against https://sourcegraph-docs-git-fix-reworded-a-00be0c-sourcegraph-f8c71130.vercel.app: 28 resolve, 0 fail.
Page rendered = the target page's first heading id is present (the 404 page never has it); Anchor = the #fragment is an id on the page. Old links point at the current site.

All 28 links
File containing the link Old link (broken today) New link (preview) Page rendered Anchor found
docs/code-navigation/auto-indexing-configuration.mdx #index-job-steps #steps
docs/code-navigation/auto-indexing-configuration.mdx #index-job-indexer #indexer
docs/code-navigation/auto-indexing-configuration.mdx #index-job-local-steps #local_steps
docs/code-navigation/auto-indexing-configuration.mdx #index-job-indexer-args #indexer_args
docs/code-navigation/auto-indexing-configuration.mdx #index-job-root #root
docs/code-navigation/auto-indexing-configuration.mdx #index-job-outfile #outfile
docs/code-navigation/auto-indexing-configuration.mdx #index-job-requested-envvars #requested_envvars
docs/code-navigation/auto-indexing-configuration.mdx #docker-step-image #image
docs/code-navigation/auto-indexing-configuration.mdx #docker-step-commands #commands
docs/code-navigation/auto-indexing-configuration.mdx #docker-step-root #root-1
docs/code-navigation/auto-indexing.mdx /self-hosted/workers#codeintel-auto-indexing /self-hosted/workers#codeintel-autoindexing-scheduler
docs/code-navigation/envvars.mdx /self-hosted/workers#codeintel-commitgraph /self-hosted/workers#codeintel-commitgraph-updater
docs/code-navigation/envvars.mdx /self-hosted/workers#codeintel-auto-indexing /self-hosted/workers#codeintel-autoindexing-scheduler
docs/code-navigation/envvars.mdx /self-hosted/workers#codeintel-janitor /self-hosted/workers#codeintel-upload-janitor
docs/code-navigation/explanations/uploads.mdx /self-hosted/workers#codeintel-commitgraph /self-hosted/workers#codeintel-commitgraph-updater
docs/code-navigation/inference-configuration.mdx #sg-autoindex-recognizers #sgautoindexrecognizer
docs/code-navigation/precise-code-navigation.mdx /code-navigation/how-to/index-a-go-repository#manual-indexing /code-navigation/how-to/index-a-go-repository#indexing
docs/code-navigation/precise-code-navigation.mdx /code-navigation/how-to/index-a-typescript-and-javascript-repository#manual-indexing /code-navigation/how-to/index-a-typescript-and-javascript-repository#one-off-indexing-using-scip-typescript-locally
docs/code-search/features.mdx /code-search/queries#diff-and-commit-searches-only /code-search/queries#filters-diff-and-commit-searches-only
docs/code-search/how-to/opengrok.mdx /code-search/queries#regexp-search /code-search/queries#regular-expression-search
docs/code-search/how-to/opengrok.mdx /code-search/queries#Literal-search-default /code-search/queries#keyword-search-default
docs/code-search/how-to/opengrok.mdx /code-search/features#version-contexts-experimental /code-search/features#search-contexts
docs/code-search/how-to/opengrok.mdx /code-search/queries#Literal-search-default /code-search/queries#keyword-search-default
docs/code-search/how-to/opengrok.mdx /code-search/queries#regexp-search /code-search/queries#regular-expression-search
docs/code-search/how-to/opengrok.mdx #search-keywords #search-filters
docs/code-search/queries/index.mdx #repository-name-search #repository-names
docs/code-search/queries/index.mdx #search-pattern-syntax #search-patterns
docs/code-search/types/symbol.mdx /code-search/features#multi-branch-indexing-experimental /code-search/features#multi-branch-indexing

Amp threads

@vercel

vercel Bot commented Sep 7, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
sourcegraph-docs Ready Ready Preview Sep 7, 2026 11:26pm UTC

Request Review

@marcleblanc2 marcleblanc2 changed the title Fix broken heading links (28 reworded, code search & navigation) fix/links: Fix broken heading links (28 reworded, code search & navigation) Sep 9, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant