coder / coder/balatrobot

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

Open
#227 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
72
Forks
18
PR merge metrics
No merged PRs in 30d

Description

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

- [x] Read `src/lua/core/*`, `utils/gamestate.lua`, `platforms/*`, ADRs 0001–0003; write with maintainer review
- [x] Cross-link to reference pages (never duplicate facts)
- [x] 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
- [x] Code paths cited with GitHub links

Contributor guide

Open the contributing guide

Research direction

Review the drafts for architecture.md, game-state.md, and runtime.md against src/lua/core/*, utils/gamestate.lua, platforms/*, and ADRs 0001–0003. Confirm that each page is titled “About X,” answers one question, uses concrete examples, cites code paths, and cross-links rather than duplicates the Phase 1 reference pages. Done means all three pages have maintainer review; check #226 first because this issue depends on it.

Written by the indexing model from the issue text.

Assessment

Tech stack
lua
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.