Unity-Customer-Template/docs/CODEX_INSTRUCTIONS.md

Codex Instructions

Repository Purpose

This repository is the master template for Runlevel Systems DevPlus1 customer debugging and analysis projects.

Expected Workflow

1. Read this documentation set first.
2. Run or inspect validation automation.
3. Review generated reports before making assumptions about customer code.
4. Treat customer code errors as reportable debugging inputs, not workflow failures.

Expected Reports

• reports/errors.md
• reports/project-flow.md
• reports/file-summary.md
• reports/languages.md
• reports/summary.md
• reports/generated-files.md
• reports/api-reference.md
• reports/file-purpose.md
• reports/unity-scripts.md
• reports/call-map.md
• reports/code-docs-summary.md

Expected Validation Behavior

• Green workflow means automation completed.
• Red workflow means automation failed.
• Customer code errors do not fail workflows.
• Customer code errors are reported in reports/errors.md.
• Reports should always be generated whenever possible.
• New validators should be added through VALIDATORS.md.
• New workflows should be documented in WORKFLOWS.md.
• Code documentation reports are generated by tools/generate-code-docs.sh.
• The code documentation generator is read-only against customer source files.

Recommended File Reading Order For Codex

1. docs/CODEX_INSTRUCTIONS.md
2. docs/README.md
3. docs/ARCHITECTURE.md
4. docs/WORKFLOWS.md
5. docs/REPORTS.md
6. docs/VALIDATORS.md
7. docs/REPOSITORY_MAP.md

Maintenance Rule

Update this file whenever automation behavior changes. These docs are authoritative and should stay current as the repository evolves.