Skip to content

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

  1. Copy NNNN-template.md and assign the next number.
  2. Fill in the sections. Keep it concise.
  3. Submit as a pull request for review.
  4. 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

#TitleStatus
0001Device Lifecycle PhasesAccepted
0002Provider InterfaceAccepted
0003Status ConditionsAccepted
0004Device Resource LockingAccepted
0005Brick ArchitectureAccepted
0006API Deprecation StrategyAccepted
EU and German government funding logos

Funded by the European Union – NextGenerationEU.

The views and opinions expressed are solely those of the author(s) and do not necessarily reflect the views of the European Union or the European Commission. Neither the European Union nor the European Commission can be held responsible for them.