Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.encoreos.io/llms.txt

Use this file to discover all available pages before exploring further.

This runbook keeps AGENTS.md and nested AGENTS files high-signal and low-noise.

Goals

  • keep always-loaded agent context concise
  • avoid duplication across constitution.md, AI_GUIDE.md, and AGENTS.md
  • preserve non-discoverable “landmine” guidance
  • detect stale instructions before they mislead agents

Canonical Responsibilities

  • constitution.md: normative guardrails and policy
  • AI_GUIDE.md: implementation process and spec workflow
  • AGENTS.md: quick reference, routing, and canonical “What AI Must NEVER Do”
  • nested src/**/AGENTS.md: module-scoped constraints and routing

Landmine Date Markers

When adding a non-discoverable gotcha, include [YYYY-MM]. Example:
- [2026-05] First typecheck run can take 5-7 minutes while tsc cache warms.

Staleness Audit

Run periodically:
npm run audit:agent-doc-staleness
Fail CI/governance on stale markers:
npm run audit:agent-doc-staleness:strict
The strict check flags [YYYY-MM] markers older than 90 days.

Maintenance Cadence

  • monthly:
    • run staleness audit
    • prune duplicated/discoverable instructions
    • verify links and command references
  • quarterly:
    • run agents-memory-updater maintenance pass in Cursor
    • review high-churn module AGENTS files for size and relevance

agents-memory-updater Workflow

Suggested prompt:
Audit AGENTS.md + nested AGENTS files for stale instructions, duplicate guidance, and missing landmines.
Return:
1) stale/incorrect lines with file paths,
2) concrete patch suggestions,
3) a prioritized update list.
Apply suggested edits only after human review.