Skip to content

Facts

YAML files that are the canonical source for AGENTS.md. scripts/compile-agents-md.sh reads these and produces AGENTS.md; --check mode detects drift in CI.

Pattern: edit YAML → run compile script → commit both. CI fails if AGENTS.md is out of sync.

  • stack.yaml — runtime, package manager, linters (when this repo has its own runtime; currently content-only)
  • conventions.yaml — commit format, branch names, MCP servers
  • pitfalls.yaml — numbered anti-patterns, max 12
  • schema.json — JSON Schema draft-07 validating all three

Not yet populated — this repo is docs/content only (no runtime to describe). The compiled AGENTS.md pattern lives in rig-gitops/ where it governs all agents reading the rig-wide contract. This directory is a placeholder for rig-docs-specific conventions if they emerge.