docs(phase-2): add explanation pages (architecture, game-state, runtime)
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Aptitud para principiantes
- 48/100
- Tipo de issue
- Documentación
- Claridad
- Bastante claro
- Estado de actividad
- Tranquilo
- Stack tecnológico
- lua
- Área
- documentation
Línea de trabajo
Revisa los borradores de architecture.md, game-state.md y runtime.md comparándolos con src/lua/core/, utils/gamestate.lua, platforms/ y los ADRs 0001–0003. Confirma que cada página tenga el título “About X”, responda a una pregunta, use ejemplos concretos, cite rutas de código y enlace a las páginas de referencia de la Phase 1 en lugar de duplicarlas. Se considera hecho cuando las tres páginas hayan recibido una revisión de maintainer; comprueba primero #226 porque este issue depende de él.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
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
- Lenguaje dominante
- Python
- Estrellas
- 80
- Forks
- 23
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Preparar el entorno
- Sin Dockerfile ni archivo de Docker Compose
- Sin plantilla de pull request
- Leer la guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de coder/balatrobot
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 85/100
coder/balatrobot#244 ·
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 85/100
coder/balatrobot#243 ·
-
Dificultad 4/5 3-5 días Aptitud para principiantes 48/100
coder/balatrobot#235 ·
-
Dificultad 4/5 3-5 días Aptitud para principiantes 48/100
coder/balatrobot#234 ·
-
Dificultad 4/5 3-5 días Aptitud para principiantes 45/100
coder/balatrobot#233 ·
Todos los issues de coder/balatrobot
Issues similares
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 84/100
pylint-dev/pylint#11791 ·
Los mantenedores suelen responder en 1 día
-
Rasterio granule reads never retry, so one 503 (Service Unavailable) fails the whole requestPosiblemente ocupada @chuckwondo la tomó hoy. Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
developmentseed/titiler-cmr#305 ·
Los mantenedores suelen responder en 1 día
-
community enhancement
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
Los mantenedores suelen responder en 1 día
-
bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 86/100
Los mantenedores suelen responder en 1 día