2026-06-28 23:00:40 +00:00
|
|
|
# Codex Game Studio Docs
|
|
|
|
|
|
2026-07-10 15:08:21 +00:00
|
|
|
This directory is intentionally small. Keep durable user-facing guidance here and keep game-studio operating surfaces in tracked template files:
|
2026-06-28 23:00:40 +00:00
|
|
|
|
2026-06-30 02:44:57 +00:00
|
|
|
- `AGENTS.md`
|
|
|
|
|
- `.codex/agents/*.toml`
|
|
|
|
|
- `.codex/workflows/*.md`
|
|
|
|
|
- `.agents/skills/*/SKILL.md`
|
2026-06-28 23:00:40 +00:00
|
|
|
|
2026-06-30 02:44:57 +00:00
|
|
|
## Start here
|
2026-06-28 23:00:40 +00:00
|
|
|
|
|
|
|
|
| Doc | Purpose |
|
|
|
|
|
| --- | --- |
|
2026-06-30 02:44:57 +00:00
|
|
|
| [User Guide](user-guide.md) | Installation, commands, role runs, workflow prompts, tasks, validation, and troubleshooting. |
|
|
|
|
|
| [Examples](examples/README.md) | Scenario-based examples for common local workflows. |
|
|
|
|
|
| [Product Boundary](architecture/product-boundary.md) | Implemented scope, non-goals, and boundaries. |
|
2026-07-10 15:08:21 +00:00
|
|
|
| [Documentation Governance](standards/documentation-governance.md) | Ownership and maintenance rules for framework documentation. |
|
2026-06-28 23:00:40 +00:00
|
|
|
|
|
|
|
|
## Update rules
|
|
|
|
|
|
2026-07-10 15:08:21 +00:00
|
|
|
- Keep framework documentation separate from the design, architecture, production, and release records of an initialized game.
|
2026-06-30 02:44:57 +00:00
|
|
|
- Do not add dated plans or one-off implementation notes under `docs/`.
|
|
|
|
|
- Do not duplicate the agent, workflow, or skill catalogs in prose docs.
|
|
|
|
|
- Keep the root README concise and link here only for durable guidance.
|
|
|
|
|
- Prefer deleting stale docs over maintaining parallel current-state descriptions.
|
