Design Documents
This directory contains design documents for the Network Operator project. They record architectural decisions and serve as guardrails for new development.
Not every change requires a design document — only those that introduce new abstractions, change existing behavior in a non-trivial way, or establish patterns that future contributions must follow. Bug fixes, new brick implementations following existing patterns, and additive API fields do not need a design doc.
Process
- Copy
NNNN-template.mdand assign the next number. - Fill in the sections. Keep it concise.
- Submit as a pull request for review.
- Once merged with status
Accepted, the decision is binding.
To supersede a design document, create a new one referencing the original and update the original's status to Superseded by NNNN.
Index
| # | Title | Status |
|---|---|---|
| 0001 | Device Lifecycle Phases | Accepted |
| 0002 | Provider Interface | Accepted |
| 0003 | Status Conditions | Accepted |
| 0004 | Device Resource Locking | Accepted |
| 0005 | Brick Architecture | Accepted |
| 0006 | API Deprecation Strategy | Accepted |