Skip to content

Implementation Repository AGENTS.md Template

Use this template only after the implementation repository has:

  • docs/bootstrap/BootstrapContext.md
  • docs/process/ChangeWorkflow.md
  • docs/core/
  • docs/state/
  • docs/process/
  • docs/changes/
  • mkdocs.yml, hooks.py, docs/index.md, and docs/stylesheets.css
# AGENTS.md

This file applies to the `<implementation-repository>/` repository root.

## Repository Purpose

<One concise paragraph explaining the implementation capability this repository owns. Base this on docs/bootstrap/BootstrapContext.md and current repository contents.>

## Ownership Boundaries

This repository owns:

- <owned implementation capability>
- <owned implementation capability>

This repository does not own:

- product-main planning, which belongs in `<product-main-repository>`
- implementation capabilities owned by other repositories
- shared Anuva process, which belongs in `anuva-engineering-handbook`

## Read First

- `docs/bootstrap/BootstrapContext.md`: repository purpose and bootstrap context.
- `docs/process/ChangeWorkflow.md`: local implementation change workflow.
- `docs/core/<page>.md`: current system behavior.
- `docs/state/<page>.md`: routing, runtime, persistence, operational, or repository state orientation.
- `<additional local doc>`: <why Codex should read it>.

## Common Commands

Run from the repository root.

- `<install command>`
- `<dev command>`
- `<lint command>`
- `<typecheck command>`
- `<test command>`
- `<build command>`
- `git diff --check`
- `mkdocs build --strict`

## Working Rules

- Implement only this repository's owned scope.
- Follow `docs/process/ChangeWorkflow.md` before changing code.
- Preserve unrelated user changes.
- Update generated files when the repository workflow requires it.
- Stop and return to product-main or handbook planning when ownership boundaries, shared contracts, or cross-repository behavior are unclear.

## Documentation Rules

- Update `docs/core` when current implementation behavior changes.
- Update `docs/state` when routing, runtime, persistence, operational state, or verification orientation changes.
- Update `docs/process` when repository-local workflows change.
- Update `docs/changes` for large changes.
- Update only the `nav` section of `mkdocs.yml` when docs under `docs/core`, `docs/state`, `docs/process`, or `docs/changes` are created, renamed, moved, or deleted.
- Update `anuva-engineering-handbook` when shared Anuva process, ownership, templates, prompts, or registry rules change.

## Change Workflow

Follow `docs/process/ChangeWorkflow.md`.

Before creating a large change implementation plan, make sure `ChangeBreakdown.md` exists and user questions are answered.

## Verification

- Small docs-only change: `git diff --check`
- Docs build: `mkdocs build --strict`
- Normal code change: `<lint/typecheck/test commands>`
- Broad or risky change: `<integration/build/smoke commands>`

If a check cannot be run, explain why in the final response.