ドキュメント標準
Luna-Flow/stella のドキュメントは、現在のブランチに存在する実装だけを記述し、公開面・リポジトリ構成・リリース叙述と常に整合していなければなりません。
Rules
- 各対応言語で
README.md、doc_standard.md、モジュールまたはサブシステム文書をそろえる。 - 現在のブランチに存在しない API や運用手順は書かない。
- ディレクトリ構成は実際のパッケージ境界またはサブシステム境界に合わせる。
- 各モジュールまたはサブシステム配下に
api.md、tutorial.md、design.mdを置く。 - 可観測な差異がある場合は、関連ページを相互参照しつつ明示する。