diff --git a/docs/AGENTS.md b/docs/AGENTS.md new file mode 100644 index 0000000..a60db99 --- /dev/null +++ b/docs/AGENTS.md @@ -0,0 +1,32 @@ +# Documentation rules for this repository + +The workspace writing standard is authoritative for every document here. It is at +`D:\orisys_ws\docs\AUTHORING.md` on disk, not in this repository. + +This file exists because that standard is not auto-discovered from inside a repository: the +workspace skill root is `D:\orisys_ws\.agents\skills\`, and an agent whose working directory is +`D:\orisys_ws\orisys-sensor-design` resolves its project root to this repository's `.git`. Read +the standard at the path above. + +## Where this repository's documents belong + +| Document | Home | +|---|---| +| The exported unwarp map and nominal geometry contract | `docs/design-parameters.md` | +| How to re-run the probe and how to read its output | `docs/probe-method.md`, `docs/probe-pipeline.md` | +| Measured probe results | `docs/probe-findings.md` | +| Blender authoring decisions and rejected alternatives | a decision record under `docs/` | +| Throwaway: rendered frames, per-run job files, sweep logs | `build/` (already gitignored) | + +The last row matters most here: this repository generates ~90 MB of derived probe output per +run. That is regenerated output, not design input, and it must not be promoted into `docs/`. + +## Check your documents before finishing + +```powershell +python D:\orisys_ws\scripts\doc_lint.py # changed Markdown — must pass +python D:\orisys_ws\scripts\doc_lint.py --all # audit the whole corpus +``` + +`tools/lint_gate.py` runs this alongside Ruff. Oversized documents already present are recorded +in `D:\orisys_ws\docs\inventory.json` with a written reason, so only new growth fails.