orisys-tech/orisys-sensor-design
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

modify agents.md to follow parent in root

Browse Source
This commit is contained in:
ykcheungab
2026-09-30 21:23:47 +08:00
parent e7618faed4
commit 1675ccb4af
2 changed files with 19 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/AGENTS.md
+5 -30
View File
@@ -1,32 +1,7 @@
# Documentation rules for this repository
# Sensor design documentation
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.
Follow [AUTHORING](../../docs/AUTHORING.md) and [AGENTS](../../AGENTS.md).
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.
Keep Blender/export contracts and measured probe results in repository docs.
Distinguish nominal design, simulated response and hardware measurements in every parameter table.
Use tools/lint_gate.py with the design environment; see AUTHORING for required workspace tooling.