Files

T

kami d26f20c316 docs(dox): build out the DOX AGENTS.md hierarchy

Root Child DOX Index assembled, plus a per-module AGENTS.md across the tree
(core/*, infrastructure/*, apps/*, testing/*, and docs/examples/frontend/etc),
each following the DOX section shape: Purpose, Ownership, Local Contracts,
Work Guidance, Verification, Child DOX Index.

2026-06-28 20:43:27 +04:00

1.3 KiB

Raw Blame History

examples/ — AGENTS.md

Purpose

Reference configurations and workflow definitions that demonstrate how to use CORREX. These are runnable examples, not documentation prose.

Ownership

Kept in sync with the features they exercise. When a kernel contract changes (tool names, config keys, stage shape), update affected examples.

Local Contracts

workflows/ — TOML workflow definitions (decompose→gather→report, role_pipeline, review_loop, etc.) plus a prompts/ subdirectory for prompt text files referenced by those workflows. These are the canonical examples for the [tools.research] config and freestyle/plan workflows.
configs/ — currently empty; reserved for example correx.toml server configs.
plugins/ — currently empty; reserved for example plugin descriptors.
stages/ — currently empty; reserved for example stage definitions.

Each TOML file in workflows/ is a valid workflow loadable by the server. Keep them working against the current kernel API.

Work Guidance

Add a new workflow example when a major new workflow type ships.
Prompts referenced by TOML files go in workflows/prompts/.
Do not add configs/plugins/stages stubs speculatively — populate when there is real content.

Verification

None yet.

Child DOX Index

No child AGENTS.md (leaf directory).

1.3 KiB Raw Blame History