fix(docs): repair broken root .md links breaking Deploy Docs#10
Merged
Conversation
Docusaurus docs root is ../docs, so ../../VISION.md etc. resolved to site-absolute paths that don't exist, breaking Deploy Docs (onBrokenLinks=throw). Point to canonical GitHub blob URLs. Verified npm run build passes.
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.
Problem
Deploy Docs workflow failing on main: Docusaurus
onBrokenLinks: throwcaught broken links indocs/features/grok-stt.mdandgrok-tts.mdpointing to../../VISION.md,../../ARCHITECTURE.md,../../SECURITY.md. Docs root is../docs, so those resolved to nonexistent site-absolute paths.Fix
Point the three links to canonical GitHub blob URLs (the files live at repo root, outside the docs tree).
Verification
npm run buildpasses locally — no broken links, static files generated.Note
Low Risk
Documentation-only link target changes with no effect on application code, auth, or data handling.
Overview
Fixes Deploy Docs failures from Docusaurus
onBrokenLinks: throwby updating the “Higher-level” cross-links indocs/features/grok-stt.mdanddocs/features/grok-tts.md.Those pages previously used
../../VISION.md,../../ARCHITECTURE.md, and../../SECURITY.md, which don’t resolve correctly from the docs site (repo-root markdown lives outside the docs tree). Each link now points at the canonical GitHub blob URL onmainfor the same three files.No runtime or provider code changes—docs-only.
Reviewed by Cursor Bugbot for commit 347ffc9. Bugbot is set up for automated code reviews on this repo. Configure here.