fix/links: Fix broken heading links (19 reworded, Cody / Batch Changes / Code Insights) - #1871
Open
marcleblanc2 wants to merge 2 commits into
Open
fix/links: Fix broken heading links (19 reworded, Cody / Batch Changes / Code Insights)#1871marcleblanc2 wants to merge 2 commits into
marcleblanc2 wants to merge 2 commits into
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
…cker slugged only the link text) Amp-Thread-ID: https://ampcode.com/threads/T-01a07623-9d65-7356-96b8-2bebb31ffa5a Co-authored-by: Amp <amp@ampcode.com>
marcleblanc2
changed the title
marcleblanc2
changed the title
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.
Linear FE-499: Fix doc site issues
Smaller, more easily reviewed subset of fixes from #1861
#anchorlinks underdocs/cody/, docs/batch-changes/ and docs/code-insights/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
#configurationor#upgrade-typessection) are the ones worth a second look.Left alone on purpose:
/batch-changes/faq#how-can-i-use-github-expression-syntax---literally-in-my-batch-specand/batch-changes/batch-spec-cheat-sheet#write-a-github-actions-workflow-that-includes-github-expression-syntax— #1861 changed them, but they work: the headings contain a link and the checker slugged only the link text (fixed in #1858).Held back: two links in
docs/batch-changes/batch-spec-yaml-reference.mdxanddocs/batch-changes/site-admin-configuration.mdxshare lines with fixes in #1864; they go there instead.Checker findings (
npm run check-links -- --check-anchors, from #1858, with its heading-slug fix): 278 on main → 259 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 19 changed links against https://sourcegraph-docs-git-fix-reworded-a-b4e9fa-sourcegraph-f8c71130.vercel.app: 19 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 19 links
docs/batch-changes/batch-spec-templating.mdx#template-helpers-functions#template-helper-functionsdocs/batch-changes/batch-spec-templating.mdx#template-helpers-functions#template-helper-functionsdocs/batch-changes/batch-spec-yaml-reference.mdx#outputs-value#stepsoutputsnamevaluedocs/batch-changes/configuring-credentials.mdx#types-of-access-tokens-used-by-batch-changes#types-of-credentials-used-by-batch-changesdocs/batch-changes/create-a-batch-change.mdx/batch-changes/create-a-batch-change#previewing-workspaces/batch-changes/create-a-batch-change#previewing-batch-spec-and-workspacesdocs/batch-changes/handling-errored-changesets.mdx#manual-retrying-by-re-applying-the-batch-change-spec#manual-retrying-of-errored-changesetsdocs/batch-changes/reexecuting-batch-specs-multiple-times.mdx/batch-changes/batch-spec-yaml-reference#environmentarray/batch-changes/batch-spec-yaml-reference#stepsenvdocs/code-insights/explanations/automatically-generated-data-series.mdx/code-insights/references/common-use-cases#automatic-version-and-pattern-tracking/code-insights/references/common-use-cases#versions-and-patternsdocs/code-insights/explanations/code-insights-filters.mdx/code-search/working/search-contexts#beta-query-based-search-contexts/code-search/working/search-contexts#query-based-search-contextsdocs/code-insights/how-tos/creating-a-custom-dashboard-of-code-insights.mdx/code-insights/explanations/viewing-code-insights#dashboard-visibility-respects-insights-visibility/code-insights/explanations/viewing-code-insights#dashboard-visibilitydocs/code-insights/how-tos/filtering-an-insight.mdx/code-search/working/search-contexts#beta-query-based-search-contexts/code-search/working/search-contexts#query-based-search-contextsdocs/code-insights/how-tos/filtering-an-insight.mdx/code-search/working/search-contexts#beta-query-based-search-contexts/code-search/working/search-contexts#query-based-search-contextsdocs/code-insights/language-insight-quickstart.mdx/code-insights/quickstart#1-enable-the-experimental-feature-flag/code-insights/quickstart#1-if-need-be-enable-the-experimental-feature-flagdocs/code-insights/references/common-use-cases.mdx/code-insights/references/common-reasons-code-insights-may-not-match-search-results#not-including-fork-no-and-archived-no-in-your-insight-query/code-insights/references/common-reasons-code-insights-may-not-match-search-results#for-versions-pre-340-not-including-forkno-and-archivedno-in-your-insight-querydocs/cody/capabilities/agentic-context-fetching.mdx#terminal-commands#terminal-accessdocs/cody/capabilities/chat.mdx/cody/capabilities/supported-models#chat-and-commands/cody/capabilities/supported-models#chat-and-promptsdocs/cody/clients/cody-with-sourcegraph.mdx/cody/capabilities/supported-models#chat-and-commands/cody/capabilities/supported-models#chat-and-promptsdocs/cody/clients/install-jetbrains.mdx/cody/core-concepts/context/#context-fetching-mechanism/cody/core-concepts/context#cody-context-fetching-featuresdocs/cody/clients/install-vscode.mdx/cody/core-concepts/context/#context-fetching-mechanism/cody/core-concepts/context#cody-context-fetching-featuresAmp threads