fix/links: Fix broken link markup (5 lines) - #1867
Open
marcleblanc2 wants to merge 1 commit into
Open
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
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
Markup, not link targets:
docs/batch-changes/batch-spec-yaml-reference.mdx:`"true```and`"*```— a stray backtick broke the inline code and swallowed the rest of the linedocs/technical-changelog.mdx: a stray)in "o)rder" left over from a mangled linkdocs/self-hosted/deploy/kubernetes/configure.mdx,operations.mdx:<QuickLink href="#">placeholders now point at the page they describeReview: render the two batch-spec lines on the preview and confirm the inline code closes where it should.
Checker findings (
npm run check-links -- --check-anchors, from #1858, with its heading-slug fix): 278 on main → 276 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 2 changed links against https://sourcegraph-docs-git-fix-link-markup-sourcegraph-f8c71130.vercel.app: 2 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 2 links
docs/self-hosted/deploy/kubernetes/configure.mdx#/self-hosted/deploy/kubernetes/configuredocs/self-hosted/deploy/kubernetes/operations.mdx#/self-hosted/deploy/kubernetes/operationsAmp threads