Fix dead links in ONBOARDING.md for VitePress build #211
Conversation
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
Convert source file links to inline code format and root markdown file links to GitHub URLs, since VitePress cannot resolve paths outside its scope. Resolves: #210 Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
The VitePress documentation build was failing with 16 dead link errors in
ONBOARDING.md. This PR fixes all broken links by:Converting source file links to inline code - VitePress cannot resolve paths to files outside its scope, so links like
[crates/fastly/src/main.rs](../crates/fastly/src/main.rs)are now formatted as inline code:`crates/fastly/src/main.rs`Converting root markdown links to GitHub URLs - Files like
README.md,CONTRIBUTING.md, etc. are in the repo root, not thedocs/folder, so VitePress can't resolve them. These now link directly to GitHub.Test plan
cd docs && npm run build- completes without dead link errorsResolves: #210