Public design documentation entry point
EasyEDA Monkey 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.
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. |
| Canonical Format | canonical_format/README.md | Stable EasyEDA format and API references promoted from research into public documentation. |
| Install | install-and-cli-tools.html | Public CLI install, development setup, and workspace installer pattern. |