Add design documents section - #495
Merged
Merged
Conversation
IvoGoman
approved these changes
Aug 13, 2026
swagner-de
approved these changes
Aug 13, 2026
swagner-de
force-pushed
the
design-docs
branch
from
August 13, 2026 11:41
12a7bde to
0f902e6
Compare
Introduce docs/designs/ with a template and six architectural decision records: - 0001: Device Lifecycle (phase progression, automatic pausing) - 0002: Provider Interface (capability interfaces, providerConfigRef, apistatus errors, protocol preferences) - 0003: Status Conditions (Configured/Operational/Ready, observedGeneration semantics) - 0004: Device Resource Locking (per-device Lease, wait priorities) - 0005: Brick Architecture (one-stanza one-device pattern, eventual consistency, ownership) - 0006: API Deprecation Strategy (four-step field deprecation) Update VitePress sidebar to include the new section. Signed-off-by: Felix Kästner <felix.kaestner@sap.com>
swagner-de
force-pushed
the
design-docs
branch
from
August 13, 2026 11:45
0f902e6 to
1bd3d38
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Introduce docs/designs/ with a template and six architectural decision
records:
apistatus errors, protocol preferences)
observedGeneration semantics)
consistency, ownership)
Update VitePress sidebar to include the new section.