Improve documentation links, breadcrumbs, and README structure#21
Merged
Improve documentation links, breadcrumbs, and README structure#21
Conversation
Reorder Further Reading section in README and update Previous links in 010_KEY_CONCEPTS to point to the Documentation heading.
Use ../../README.md instead of ../README.md to correctly resolve from docs/overview/ to the root README.
Place Installation and Basic Structure before Getting Started so readers see what the gem looks like before being directed to guides.
Extract breadcrumb navigation into its own section, add REFERENCE.md nav docs, and fix overview Previous link path to match actual targets.
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.
Summary
REFERENCE.mdbreadcrumb links (../docs/→ relative)Previouslink path in010_KEY_CONCEPTS.md(../→../../to reach root).claude/docs/documentation.mdwith dedicated Breadcrumb Navigation sectionTest plan