This repository was archived by the owner on Nov 21, 2025. It is now read-only.
Improve documentation alignment and accuracy #136
Merged
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
…eveal integration This commit enhances the documentation structure to better support incremental exploration using the reveal tool, fixing inconsistencies and improving navigation. ## Changes: ### claude.md - Fixed outdated references and tool usage - Updated all `reveal` command references to use `./scripts/reveal.sh` (local tool) - Corrected file paths from `src/morphogen/` to `morphogen/` - Updated test file references (test_domains/ → tests/) - Fixed reveal tool documentation with accurate usage examples - Clarified tool location and removed references to non-existent global install ### docs/README.md - Enhanced navigation and reveal tool guidance - Added "Explore efficiently" quick start item linking to reveal tool - Enhanced "Finding What You Need" section with reveal tool examples - Added new "Documentation Best Practices" section with: - Detailed reveal tool workflow (level 1 → level 2 → level 3) - Token savings estimates (5-10%, 20-30%, 100%) - Recommended exploration patterns - Added "Cross-Referencing Conventions" explaining WHY vs HOW distinction - Better integration of reveal tool throughout navigation guide ### docs/DOCUMENTATION_INDEX.md - Improved accuracy and usability - Enhanced tip section with token savings breakdown - Emphasized level 1 as "most useful for initial exploration" - Added comprehensive "Navigation Tips" section with: - Efficient exploration workflow examples - Bash commands for batch file exploration - Progressive reveal usage patterns - Added "Related Resources" section linking to other key docs - Updated timestamps to reflect current maintenance ## Benefits: - Documentation is now optimized for incremental exploration - Clear guidance on using reveal tool effectively saves time and tokens - Consistent file paths and references throughout - Better cross-referencing between philosophy, architecture, and implementation - Improved accuracy for AI assistants and developers navigating the codebase All changes maintain existing structure while enhancing discoverability and usability.
scottsen
deleted the
claude/improve-docs-accuracy-01KfsAX8uvTYS94hS4YvJKdk
branch
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
…eveal integration
This commit enhances the documentation structure to better support incremental exploration using the reveal tool, fixing inconsistencies and improving navigation.
Changes:
claude.md - Fixed outdated references and tool usage
revealcommand references to use./scripts/reveal.sh(local tool)src/morphogen/tomorphogen/docs/README.md - Enhanced navigation and reveal tool guidance
docs/DOCUMENTATION_INDEX.md - Improved accuracy and usability
Benefits:
All changes maintain existing structure while enhancing discoverability and usability.