feat: restructure documentation and add agent guidelines#10
Merged
Conversation
Split the monolithic README into focused documentation: - Created AGENTS.md with comprehensive AI coding guidelines - Split README into modular docs/ directory with 6 focused guides - Improved navigation with clear linking between documents - Added emojis and better formatting for readability Documentation Structure: - docs/getting-started.md - Installation and setup guide - docs/architecture.md - Architectural patterns and design principles - docs/development.md - Development workflow and coding standards - docs/testing.md - Testing strategies and best practices - docs/error-handling.md - Error handling system guide - docs/adding-domains.md - Step-by-step guide to add new domains AGENTS.md provides: - Build, lint, and test commands with examples - Clean Architecture layer responsibilities - Code style guidelines (imports, formatting, naming) - Error handling patterns and flows - Validation rules and custom validators - Database patterns and transaction management - Testing philosophy with real database integration - Guidelines for adding new domains - Common pitfalls to avoid README.md improvements: - Concise overview with feature highlights - Quick start section with essential commands - Clear navigation to detailed documentation - Better visual hierarchy with badges and emojis - Focused on getting developers productive quickly Domain model updates: - Added missing package documentation comments - Improved consistency in error definitions
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.
Split the monolithic README into focused documentation:
Documentation Structure:
AGENTS.md provides:
README.md improvements:
Domain model updates: