docs: add comprehensive architecture and development guideline documentation#135
Merged
Conversation
Owner
satoryu
commented
Jan 11, 2026
satoryu
commented
- Add architecture.md documenting code structure, components, and design patterns
- Add development-guideline.md with TDD workflow and coding standards
- Include practical examples and troubleshooting guides
- Document all entry points, modules, and data flows
- Provide onboarding guide for new developers
…ntation - Add architecture.md documenting code structure, components, and design patterns - Add development-guideline.md with TDD workflow and coding standards - Include practical examples and troubleshooting guides - Document all entry points, modules, and data flows - Provide onboarding guide for new developers
- Complete rewrite to focus on dependency relationships between modules - Add Mermaid diagrams visualizing architecture layers and dependencies - Document each module's dependencies and usage locations - Add sequence diagrams for data flow examples - Explain design decisions and dependency patterns - Include dependency health metrics and future improvements - Change structure from general overview to dependency-centric analysis
- Add references to docs/architecture.md in Architecture section - Add references to docs/development-guideline.md in Development Guidelines section - Update Documentation list with new docs - Add Project Documentation subsection in Resources - Add important resources note for AI agents
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
2 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.