AGENTS.md

1# DOX framework
2 
3- DOX is highly performant AGENTS.md hierarchy installed here
4- Agent must follow DOX instructions across any edits
5 
6## Core Contract
7 
8- AGENTS.md files are binding work contracts for their subtrees
9- Work products, source materials, instructions, records, assets, and durable docs must stay understandable from the nearest applicable AGENTS.md plus every parent AGENTS.md above it
10 
11## Read Before Editing
12 
131. Read the root AGENTS.md
142. Identify every file or folder you expect to touch
153. Walk from the repository root to each target path
164. Read every AGENTS.md found along each route
175. If a parent AGENTS.md lists a child AGENTS.md whose scope contains the path, read that child and continue from there
186. Use the nearest AGENTS.md as the local contract and parent docs for repo-wide rules
197. If docs conflict, the closer doc controls local work details, but no child doc may weaken DOX
20 
21Do not rely on memory. Re-read the applicable DOX chain in the current session before editing.
22 
23## Update After Editing
24 
25Every meaningful change requires a DOX pass before the task is done.
26 
27Update the closest owning AGENTS.md when a change affects:
28 
29- purpose, scope, ownership, or responsibilities
30- durable structure, contracts, workflows, or operating rules
31- required inputs, outputs, permissions, constraints, side effects, or artifacts
32- user preferences about behavior, communication, process, organization, or quality
33- AGENTS.md creation, deletion, move, rename, or index contents
34 
35Update parent docs when parent-level structure, ownership, workflow, or child index changes. Update child docs when parent changes alter local rules. Remove stale or contradictory text immediately. Small edits that do not change behavior or contracts may leave docs unchanged, but the DOX pass still must happen.
36 
37## Hierarchy
38 
39- Root AGENTS.md is the DOX rail: project-wide instructions, global preferences, durable workflow rules, and the top-level Child DOX Index
40- Child AGENTS.md files own domain-specific instructions and their own Child DOX Index
41- Each parent explains what its direct children cover and what stays owned by the parent
42- The closer a doc is to the work, the more specific and practical it must be
43 
44## Child Doc Shape
45 
46- Create a child AGENTS.md when a folder becomes a durable boundary with its own purpose, rules, responsibilities, workflow, materials, or quality standards
47- Work Guidance must reflect the current standards of the project or user instructions; if there are no specific standards or instructions yet, leave it empty
48- Verification must reflect an existing check; if no verification framework exists yet, leave it empty and update it when one exists
49 
50Default section order:
51- Purpose
52- Ownership
53- Local Contracts
54- Work Guidance
55- Verification
56- Child DOX Index
57 
58## Style
59 
60- Keep docs concise, current, and operational
61- Document stable contracts, not diary entries
62- Put broad rules in parent docs and concrete details in child docs
63- Prefer direct bullets with explicit names
64- Do not duplicate rules across many files unless each scope needs a local version
65- Delete stale notes instead of explaining history
66- Trim obvious statements, repeated rules, misplaced detail, and warnings for risks that no longer exist
67 
68## Closeout
69 
701. Re-check changed paths against the DOX chain
712. Update nearest owning docs and any affected parents or children
723. Refresh every affected Child DOX Index
734. Remove stale or contradictory text
745. Run existing verification when relevant
756. Report any docs intentionally left unchanged and why
76 
77## User Preferences
78 
79When the user requests a durable behavior change, record it here or in the relevant child AGENTS.md
80 
81## Child DOX Index
82 
83- No child AGENTS.md files are needed for the current repository structure.
84- Root-owned files: `README.md`, `LICENSE`, `banner.jpg`, `video-thumbnail.jpg`, and root-level project documentation.
85