Fix Docs Structure & Repair Internal Links #1750
Open
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
…nd update documentation structure paths.
… broken link checker script.
…uce a link checker script with a report.
…s in documentation.
…, and update workflow paths for documentation structure.
…an internal link, and update documentation structure references.
…ow paths, and fix a broken internal link.
… link in mining guide.
|
|
Collaborator
|
thank you for this, will review it soon |
Author
alright Eric |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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's changed?
This PR aligns the repository configuration with the actual file structure. Previously, config files like
SUMMARY.md and .gitbook.yaml were pointing to old directories (e.g., concepts/, guides/) that no longer exist.
I've updated them to point to the correct docs/ content (learn, build, operate, reference).
Fixes included:
Repo Structure: Updated SUMMARY.md, CLAUDE.md and workflow files to match the real folder layout.
Redirects: Fixed .gitbook.yaml to ensure old URLs redirect to the new locations.
Broken Links: Scanned and fixed critical 404s in key guides (Mining, Developer Quickstart, Stacking, etc.) where internal links were broken.
Maintenance: Added a check_links.py
script for future link validation.
Result: The documentation site should now build correctly, navigation links will actually work, and the AI bots will know where to look.