docs: streamline agent instructions and design documentation#83
Merged
Conversation
- Refactor AGENTS.md from 159 to 100 lines with clearer structure - Add architecture reference and validation requirements - Simplify task management workflow and testing guidelines - Update DESIGN.md from vision to current implementation status - Add implementation status checklist and clearer API specs - Improve component descriptions and session management docs
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
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
This PR streamlines Perry's core documentation to improve clarity and reduce redundancy:
• AGENTS.md: Refactored from 159 to 100 lines with clearer structure and validation requirements
• DESIGN.md: Updated from vision document to current implementation status with concrete architecture details
Key Improvements
AGENTS.md Changes
DESIGN.md Changes
Impact
The documentation now provides a clearer path from high-level design (DESIGN.md) to implementation guidelines (AGENTS.md) while eliminating redundant information.