Skip to content

Conversation

@HALQME
Copy link
Owner

@HALQME HALQME commented Dec 24, 2025

This pull request introduces major improvements to documentation for the btuin project, 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 English README.md to 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:

    • Deleted docs/advanced-guides.md (advanced usage in Japanese)
    • Deleted docs/api-reference.md (API reference in Japanese)
    • Deleted 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 btuin framework.

Summary of Most Important Changes:

Documentation Restructuring & Internationalization

  • Added README.ja.md with Japanese documentation, and rewrote README.md to be concise and English-focused, with clear links between the two. [1] [2]
  • Removed outdated or redundant Japanese documentation files: docs/advanced-guides.md, docs/api-reference.md, and docs/philosophy.md. [1] [2] [3]

Architecture Documentation & Visualization

  • Added new architecture documents in English and Japanese (docs/architecture.md, docs/architecture.ja.md) to explain the framework's design and modular structure. [1] [2]
  • Added a new architecture diagram (docs/assets/architecture.d2) to visually represent the application's workflow and data flow.

Provide bypassStdoutWrite and bypassStderrWrite that write directly or record
output in test mode. Add a write proxy and cache UI input/output streams so UI
rendering is routed through the bypass functions and dev TTY handles are reused.
Introduce Japanese README and translated English README Add architecture docs
(EN/JA) and diagram assets (d2 + svg) Remove several outdated detailed doc pages
@HALQME HALQME merged commit 432e927 into main Dec 24, 2025
3 checks passed
@HALQME HALQME deleted the tty-mode branch December 24, 2025 02:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants