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

Aperta
#227 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
48/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Tranquilla
Stack tecnologico
lua
Ambito
documentation

Direzione di ricerca

Esamina le bozze di architecture.md, game-state.md e runtime.md rispetto a src/lua/core/, utils/gamestate.lua, platforms/ e agli ADR 0001–0003. Conferma che ogni pagina abbia il titolo “About X”, risponda a una domanda, utilizzi esempi concreti, citi i percorsi del codice e includa collegamenti incrociati invece di duplicare le pagine di riferimento della Phase 1. Il lavoro è completato quando tutte e tre le pagine hanno ricevuto una revisione da parte di un maintainer; controlla prima #226 perché questa issue dipende da esso.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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
Lingua principale
Python
Stelle
80
Fork
23
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di coder/balatrobot

Tutte le issue di coder/balatrobot

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.