External/codex-game-studio
1
0
Fork 0
mirror of https://github.com/merlinhu1/codex-game-studio.git synced 2026-08-25 07:54:34 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs: align game studio documentation style

Browse Source
This commit is contained in:
MerlinH
2026-06-30 12:52:18 +10:00
parent 841f906dc0
commit 945d5f995a
38 changed files with 313 additions and 4339 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/README.md
+19 -57
View File
@@ -1,73 +1,35 @@
# Codex Game Studio Docs
## Purpose
This directory is intentionally small. Keep durable user-facing guidance here and keep game-studio operating surfaces in the tracked template files:
This directory keeps detailed usage, product, architecture, validation, and repository-truth material out of the root README.
- `AGENTS.md`
- `.codex/agents/*.toml`
- `.codex/workflows/*.md`
- `.agents/skills/*/SKILL.md`
The root [README](../README.md) is the concise human storefront. Use this index when you need the next layer of detail.
## Audience split
### For users
## Start here
| Doc | Purpose |
| --- | --- |
| [User Guide](user-guide.md) | Installation, commands, role runs, workflows, tasks, validation, and troubleshooting. |
| [Setup](setup.md) | Short setup commands for source checkouts and package-bin smoke checks. |
| [Examples](examples/README.md) | Scenario-based examples inspired by the CCGS example-index style. |
| [Studio Roles](studio-roles.md) | Role catalog, role groups, and guidance for choosing the right Codex role. |
| [Project Anatomy](project-anatomy.md) | Template repository tree, file ownership, and validation-sensitive artifacts. |
| [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. |
### For contributors
## Repository support docs
| Doc | Purpose |
| --- | --- |
| [Development](development.md) | Build, test, validation, package, and documentation-maintenance workflow. |
| [Workflow Validation](workflow-validation.md) | What repository and project validation check. |
| [Prompt Quality Standard](prompt-quality.md) | Source of truth for improving tracked agents, skills, and workflows. |
| [Known Upstream Differences](known-upstream-differences.md) | Intentional differences from the CCGS inspiration project. |
| [Migration from Claude](migration-from-claude.md) | Migration notes from Claude-oriented game-studio workflows. |
| [Product Boundary](architecture/product-boundary.md) | Implemented behavior, non-goals, and architecture boundaries. |
| [Repo Rules](ai/repo-rules.md) | Repository rules mirrored for agent discovery. |
| [Documentation Governance](standards/documentation-governance.md) | Rules for keeping docs concise and linked. |
| [Default Principles](standards/default-principles.md) | General project documentation principles. |
### For agents
## Truthmark support
| Doc | Purpose |
| --- | --- |
| [AGENTS.md](../AGENTS.md) | Agent entry point and repository instructions. |
| [Repo Rules](ai/repo-rules.md) | Mirrored repository-wide rules for Truthmark authority discovery. |
| [Truthmark routes](truthmark/routes/areas.md) | Route map for canonical truth docs. |
| [Product truth](truthmark/product/README.md) | Product capability promises and acceptance criteria. |
| [Engineering truth](truthmark/engineering/README.md) | Current implementation contracts, workflows, and operations. |
## Recommended reading order
### New user
1. [README](../README.md)
2. [User Guide](user-guide.md)
3. [Examples](examples/README.md)
4. [Project Anatomy](project-anatomy.md)
### Project maintainer
1. [README](../README.md)
2. [Development](development.md)
3. [Workflow Validation](workflow-validation.md)
4. [Product Boundary](architecture/product-boundary.md)
5. Relevant Truthmark product or engineering docs
### Agent changing behavior
1. [AGENTS.md](../AGENTS.md)
2. [Repo Rules](ai/repo-rules.md)
3. [Product Boundary](architecture/product-boundary.md)
4. [Truthmark routes](truthmark/routes/areas.md)
5. The nearest owning product or engineering truth doc
Truthmark support files under `docs/truthmark/` are retained only where they match the Truthmark support surface. Do not add broad product-specific truth-doc sprawl here; use tracked template files, tests, and the README/user guide first.
## Update rules
- Keep the root README concise. Move command reference, role catalog, generated-file detail, and contributor workflow detail into subdocs.
- When the root README changes materially, update localized README variants under `docs/readmes/` in the same change or state why they intentionally differ.
- When a command, workflow, generated artifact, role, or validation behavior changes, update the nearest user-facing doc and the owning Truthmark doc if it is behavior-bearing.
- Do not keep parallel current-state docs for the same subject. Link to the owning doc instead of duplicating details.
- Keep scenario examples concrete and outcome-oriented, not exhaustive command dumps.
- 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.