Reference
Use this section for durable facts and contracts that should stay stable even as the user-facing adoption lanes and contributor flows evolve.
Contributor how-to material now lives under contributing/, and user-facing routing now lives in the top-level adoption lanes.
Contents
- What OAT Writes - Every file, link and Git ref OAT creates, what to commit, and how to remove it.
- Configuration - OAT configuration guidance across shared, local, user, and provider-sync surfaces.
- Config and Local State - Utility command groups for config, local state, diagnostics, and related inspection flows.
- CLI Reference - Shallow map of the OAT command surface with links to owning sections.
- File Locations - Where core OAT files, assets, and artifacts live.
- Docs Index Contract - Authored
index.mdmaps,.mdlinks, generated Fumadocs manifests, and MkDocs and Fumadocs nav sync boundaries. .oatDirectory Structure - Canonical.oat/tree map and the role of each major directory.- Troubleshooting - Common issues, diagnostics, and remediation guidance.
- Project Artifacts - What lives in
state.md,discovery.md,plan.md,implementation.md, and related files. - State Machine - Lifecycle and review status transitions across a project.
- Repository PR Comment Analysis - Repo-wide PR comment collection and triage workflows.
What Belongs Here
- stable file and directory contracts
- docs-system rules that other pages should link to instead of re-explaining
- troubleshooting material that remains relevant across workflow and docs changes
Related Sections
- CLI Reference for the command-surface map
- Docs Tooling for docs app setup and workflow guidance
- Contributing for code, docs, and skill-authoring practices
General CLI Adoption Guidance
Use OAT's general CLI for repository setup, tool-pack management, configuration and diagnostics independently of provider sync, docs tooling or tracked workflows.
Start with Getting Started for bootstrap and tool packs. See Configuration for settings, Config and Local State for diagnostics, and Advanced for workflow gates.
Improve Agent Instructions
Audit instruction coverage and accuracy, then apply approved recommendations without inventing repository conventions.
What OAT Writes
Every file, link and Git ref that OAT commands create in your repository, under your home directory and on origin, what to commit, and how to remove all of it.