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.
This pull request introduces major improvements to documentation for the
btuinproject, focusing on clarity, internationalization, and maintainability. The English and Japanese README files are now fully separated and streamlined, new architecture diagrams and documents have been added, and outdated or redundant documentation has been removed. The API reference and philosophy documents have also been updated for consistency and clarity.Documentation Restructuring and Internationalization:
Added a new Japanese README (
README.ja.md) and rewrote the main EnglishREADME.mdto be concise, focusing on features, usage, and API overview. This separates language-specific content and simplifies onboarding for both English and Japanese readers. [1] [2]Updated the documentation structure by removing outdated or redundant docs:
docs/advanced-guides.md(advanced usage in Japanese)docs/api-reference.md(API reference in Japanese)docs/philosophy.md(project philosophy in Japanese)[1] [2] [3]
Architecture Documentation and Visualization:
Added new architecture documentation in both English (
docs/architecture.md) and Japanese (docs/architecture.ja.md) to explain the core design, module structure, headless execution, and adapter patterns. [1] [2]Introduced a new architecture diagram (
docs/assets/architecture.d2) to visually represent the application's initialization, rendering loop, and I/O flow.These changes improve the accessibility, clarity, and maintainability of the documentation, making it easier for both new and existing contributors to understand and work with the
btuinframework.Summary of Most Important Changes:
Documentation Restructuring & Internationalization
README.ja.mdwith Japanese documentation, and rewroteREADME.mdto be concise and English-focused, with clear links between the two. [1] [2]docs/advanced-guides.md,docs/api-reference.md, anddocs/philosophy.md. [1] [2] [3]Architecture Documentation & Visualization
docs/architecture.md,docs/architecture.ja.md) to explain the framework's design and modular structure. [1] [2]docs/assets/architecture.d2) to visually represent the application's workflow and data flow.