docs(phase-2): add explanation pages (architecture, game-state, runtime)

オープン
  • 何か問題がありますか？
#227 コメント 1 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
48/100
issue の種類
ドキュメント
明瞭さ
おおむね明確
活発さ
静か
技術スタック
lua
領域
documentation

調査の方向性

architecture.md、game-state.md、runtime.md のドラフトを、src/lua/core/、utils/gamestate.lua、platforms/、および ADRs 0001–0003 と照合してレビューします。各ページのタイトルが “About X” であり、1つの質問に答え、具体例を使用し、コードパスを引用し、Phase 1 のリファレンスページを重複させるのではなく相互リンクしていることを確認します。完了とは、3つすべてのページで maintainer によるレビューが済んでいることです。この issue は #226 に依存しているため、まず #226 を確認してください。

索引モデルが issue の本文から書いたものです。

説明

Part of #224 — v2 docs rewrite (Diátaxis).

Goal

Explanation pages: architecture.md, game-state.md (omniscience/fair-play), runtime.md (platforms + rendering) — each 1.5–3k words, code-cited, titled "About X".

Tasks

  • Read src/lua/core/*, utils/gamestate.lua, platforms/*, ADRs 0001–0003; write with maintainer review
  • Cross-link to reference pages (never duplicate facts)
  • One question per page; concrete examples

Dependencies

  • Blocked by: #226 (Phase 1 — reference rewrite)
  • Blocks: Phase 3 (how-to), Phase 5 (ship)

Done when

  • 3 pages reviewed by a maintainer
  • Code paths cited with GitHub links
主要言語
Python
スター
80
フォーク
23
30日以内にマージされた PR はありません

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

coder/balatrobot のほかの issue

coder/balatrobot の issue をすべて見る

似ている issue

Python の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。