saint-graves/sica-fondt
1
0
Fork 0
mirror of https://github.com/SHOGGOTH-SECTOR/sica-fondt.git synced 2026-07-31 08:06:26 +00:00
Code Issues Packages Projects Releases Wiki Activity
sica-fondt/AGENTS.md
Claude d784a92f75
docs: extract directory/doc index into docmap.yaml 
AGENTS.md was carrying the read-order + routing table inline; moved that to an
independent machine-readable docmap.yaml (read_order, routing, design_docs,
organs with build cmds, invariants, smoke). AGENTS.md slims to a prose signpost
(54->28 lines) pointing at it; CLAUDE.md docs-map lists it. YAML validated.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_015hmgREHNsxYCuim33yUF2c
2026-06-22 18:17:03 +00:00

1.4 KiB
Raw Blame History

AGENTS.md

How to use the documents in this repo — the prose signpost. The full directory/document index lives in docmap.yaml (machine-readable; start there to find which file covers what, the newcomer read-order, and the organ list). Working agreements and invariant text: CLAUDE.md. Keep this file lean (≤100 lines) — depth lives in the docs it points to.

Scope & nesting

AGENTS.md is hierarchical — an agent reads the nearest one walking up from the file it's editing. So this root file is the map; each organ owns a scoped AGENTS.md with its local build/run/invariants (see docmap.yaml → organs for the list and paths).

Keep scopes non-overlapping: the root signposts, the organs detail. Don't restate the root in an organ file (that's how the two drift) — link up instead.

Rules of the road

  • Design before code. The design docs are the source of truth; code follows.
  • Honor the invariants (S1/S2/S3 in CLAUDE.md) — the Ada border and the COBOL vault are not optional.
  • Verify, then commit. Run the smoke driver (docmap.yaml → smoke); commit
    • push before leaving (the container is ephemeral).
  • Keep the docs honest. If you change behavior, update the doc — and the docmap.yaml entry — that describes it. Keep CLAUDE.md ≤200 lines and this file ≤100.