ykcheungab
1de4431657
The workspace writing standard (D:\orisys_ws\docs\AUTHORING.md) is not auto-discovered from inside a repository: the workspace skill root is D:\orisys_ws\.agents\skills\, and an agent working here resolves its project root to this repository's .git. This file points at the standard and at the gate command, and records which kinds of document belong in this repo's docs. Without it, agents working inside the repository would not learn the budgets or the placement rules.
33 lines
1.6 KiB
Markdown
33 lines
1.6 KiB
Markdown
# 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.
|