Normalize internal doc links to relative .md paths#179
Open
Miggets7 wants to merge 1 commit into
Open
Conversation
Convert 49 URL-style internal links to relative .md file paths including the numeric prefix, matching the documented convention already used by the majority of links. Links to the generated REST API category page stay URL-based since no .md source file exists for it. Also raise onBrokenMarkdownLinks from 'warn' to 'throw' so unresolved .md links fail the build the same way URL links already do.
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.
What
/docsto relative.mdfile paths including theNNN-numeric prefix. This matches the convention already used by ~194 links./docs/category/rest-apias URLs. The category index is generated, so no.mdsource file exists for it.onBrokenMarkdownLinksfrom'warn'to'throw'indocusaurus.config.ts, so broken.mdlinks now fail the build the same way URL links already do viaonBrokenLinks: 'throw'.Why
Two link styles were mixed across the docs. The
.mdfile-path form is clickable on GitHub, resolves correctly inside versioned snapshots, and is validated at build time. Snapshots inversioned_docs/are left untouched.Verification
Full
yarn buildpasses with no broken link or anchor warnings. Every converted link target was verified to exist on disk.