Files
correx/examples/AGENTS.md
T

1.5 KiB

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/.
  • Freestyle architect prompts specify stage constraints, boundaries, and verification goals; they do not prescribe an exact resulting file list when the authoritative intent leaves implementation details open.
  • 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).