Public design documentation entry point
Altium Cruncher Design Index
This folder holds architecture, interface, test, and contract design documentation for the package. HTML design documents are intentionally simple so humans can read them in a browser and tools can inspect them with straightforward text or HTML parsers.
Policy
- Every public CLI command must have a matching design document under
docs/design/cli/. - The CLI design document filename must match the command name.
- Signoff fails when a registered command lacks its design document.
- Commands with config files must also have a machine-readable contract and validation tests.
- Public dataclasses and major interfaces must have API design docs with Rack test ownership.
Indexes
| Area | Entry Point | Purpose |
|---|---|---|
| API | api/index.html | Public dataclass and major-interface design, rationale, test requirements, and Rack ownership. |
| CLI | cli/index.html | Public command design, invocation, arguments, outputs, and tests. |
| Test Assets | test-assets.html | Fixture layout, generated Altium oracle outputs, variant folders, and output hygiene. |
| ADRs | adrs/README.md | Accepted architecture decisions and compatibility policy. |