@mrciphersmith/keryx 0.3.122 → 0.3.124

package/README.md

@@ -240,7 +240,7 @@ affected graph supplies deterministically, in one command.
 ├── memory/               # lessons, decisions, constraints, known mistakes
 ├── skills/               # bundled agent skills and routing
 ├── project-skills/       # skills generated from your own modules
-├── rules/                # your AGENTS.md / CLAUDE.md as project rules
+├── rules/                # bundled rules; rules/project/ holds yours and is read first
 ├── data/gdgraph/         # graph artifacts, module map, query results
 ├── data/testing/         # test context, related tests, normalized reports
 ├── data/health/          # normalized health artifacts and trends
@@ -255,6 +255,26 @@ a human wants to look at it (`keryx dash`):
   <img src="https://raw.githubusercontent.com/MrCipherSmith/keryx/main/docs/assets/dashboard.png" alt="The keryx dashboard: health score, attention signals, and the enabled modules" width="880">
 </p>
 
+### Your rules, applied first
+
+`keryx skills import --rules <dir>` copies your rule files into
+`.metaproject/rules/project/`. When an agent is about to write code or tests,
+`keryx skills resolve-context` lists which rules and skills it must read —
+yours before the bundled ones — and the task is checked against what the agent
+says it read (`warn` by default, `block` on request).
+
+A long document your rules point at, such as `STYLING.md` or `THEMING.md`, can
+be required only when the task needs it. List it in
+`.metaproject/rules/project/references.json` with the globs and keywords that
+make it required and, optionally, the heading to read. `resolve-context
+--task-text '<task>'` then promotes it to `must_read`, the worker names the
+heading and writes a short summary of what it read, and `keryx skills
+references check` and `suggest` help you write the declarations. The summary
+check is a proxy: keryx cannot see what an agent opens, and a summary that
+reuses the section's words passes. How often a document is required depends on
+how broad its globs and keywords are. See
+[Make agents follow my project's own rules](https://github.com/MrCipherSmith/keryx/blob/main/docs/docs/guides/apply-project-rules.md).
+
 ## The agent harness
 
 This is the half that makes the other half worth having.