codex-game-studio/docs

Codex Game Studio Docs

Purpose

This directory keeps detailed usage, product, architecture, validation, and repository-truth material out of the root README.

The root README is the concise human storefront. Use this index when you need the next layer of detail.

Audience split

For users

Doc	Purpose
User Guide	Installation, commands, role runs, workflows, tasks, validation, and troubleshooting.
Setup	Short setup commands for source checkouts and package-bin smoke checks.
Examples	Scenario-based examples inspired by the CCGS example-index style.
Studio Roles	Role catalog, role groups, and guidance for choosing the right Codex role.
Project Anatomy	Generated project tree, file ownership, and validation-sensitive artifacts.

For contributors

Doc	Purpose
Development	Build, test, validation, package, and documentation-maintenance workflow.
Workflow Validation	What repository and project validation check.
Known Upstream Differences	Intentional differences from the CCGS inspiration project.
Migration from Claude	Migration notes from Claude-oriented game-studio workflows.
Product Boundary	Implemented behavior, non-goals, and architecture boundaries.

For agents

Doc	Purpose
AGENTS.md	Agent entry point and repository instructions.
Repo Rules	Mirrored repository-wide rules for Truthmark authority discovery.
Truthmark routes	Route map for canonical truth docs.
Product truth	Product capability promises and acceptance criteria.
Engineering truth	Current implementation contracts, workflows, and operations.

Recommended reading order

New user

1. README
2. User Guide
3. Examples
4. Project Anatomy

Project maintainer

1. README
2. Development
3. Workflow Validation
4. Product Boundary
5. Relevant Truthmark product or engineering docs

Agent changing behavior

1. AGENTS.md
2. Repo Rules
3. Product Boundary
4. Truthmark routes
5. The nearest owning product or engineering truth doc

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.