Documentation Standard

このリポジトリのドキュメントは、現在のブランチに存在する実装を説明します。 現在の基準は v0.5.1 です。

ドキュメント種類

1. API Reference (api.md): 公開型、関数、引数、戻り値の意味。
2. User Guide (tutorial.md): 実践的な流れと実行例。
3. Design Documentation (design.md): アーキテクチャ、制約、拡張点、制限。

構成

doc/
  en_US/
  zh_CN/
  ja_JP/
    core/
      api.md
      tutorial.md
      design.md
    view/
      api.md
      tutorial.md
      design.md
    frontend/
      api.md
      tutorial.md
      design.md
    backend-tui/
      api.md
      tutorial.md
      design.md
    backend-canvas/
      api.md
      tutorial.md
      design.md
    demo/
      api.md
      tutorial.md
      design.md

保守ルール

• ドキュメントは実装済みコードと一致させます。
• scene graph、material、texture、physics、BVH、asset loader など未実装の engine 機能は記述しません。
• geometry core の説明に terminal、ANSI、TUI background の詳細を混ぜません。
• terminal y-scale、background pattern、character rasterization は backend-tui または demo に、browser DOM、Canvas、scanline、JS target の詳細は backend-canvas または demo に記述します。
• サブシステム境界をまたぐ挙動を変更した場合は、API、tutorial、design を一緒に更新します。