docs

Documentation

How to Read This

Three paths depending on what you need:

You want to...	Start here
Set up a new project	start.md
Fix a messy existing project	triggers.md
Understand the principles	philosophy.md

The Three Stages

Stage 1 is enough for most projects. Only add more structure when something starts going wrong.

Stage	When	What
1. Start	Any project	AGENTS.md + todo.md
2. Grow	Things get messy	Domain/adapters, decisions, ports, testing
3. Enforce	Rules keep getting broken	Linters, import checks, CI/CD
AI Workflow	Any stage	Multi-perspective reviews, session habits, reusable agents

Not sure if you should move stage? Check the triggers.

Resources

Everything that is not part of the core path. Look things up when you need them.

Document	What it covers
triggers.md	When to move between stages (symptom table)
prompts.md	All copy-paste AI prompts on one page
ai-code-review.md	Multi-perspective review workflow before commits and PRs
auto-documentation.md	Generate developer docs and Mermaid diagrams from your codebase
domain-and-adapters.md	The architecture pattern behind Stage 2
architecture-patterns.md	Feature-sliced, modular monolith, vertical slices
testing.md	How testing works, TDD with AI, what to test
dependency-evaluation.md	How to evaluate and add third-party dependencies safely
security.md	Input validation, secrets, auth, common vulnerabilities
performance.md	Database, caching, timeouts, crash recovery
build-pipeline.md	Local build pipeline, reproducible builds, release automation
release-checklist.md	What to check before publishing a project
language-conventions.md	Which language to use where (code, comments, docs, commits)
philosophy.md	Five principles, Pace Layers, why codeOath works

Language Guides

How codeOath concepts translate to specific languages.

Language	File
Python	python.md
Rust	rust.md

Project Meta

Internal documents for codeOath itself.

Document	Purpose
decisions.md	Architecture decisions for codeOath itself
style-guide.md	Formatting rules for all docs
todo.md	Open tasks