Doc update: update overview page and architecture runtime flow/sequence diagrams#307
Merged
felix-kaestner merged 3 commits intomainfrom Apr 17, 2026
Merged
Doc update: update overview page and architecture runtime flow/sequence diagrams#307felix-kaestner merged 3 commits intomainfrom
felix-kaestner merged 3 commits intomainfrom
Conversation
elinalin
requested review from
felix-kaestner,
nikatza,
swagner-de and
weneghawi
hardikdr
added
the
area/switch-automation
Co-authored-by: Felix Kästner <felix.kaestner@sap.com>
Co-authored-by: Felix Kästner <felix.kaestner@sap.com>
felix-kaestner
force-pushed
the
doc/architecture-workflow
branch
from
21dd9df to
95a5356
Compare
felix-kaestner
approved these changes
Apr 17, 2026
felix-kaestner
pushed a commit
that referenced
this pull request
Apr 17, 2026
weneghawi
pushed a commit
that referenced
this pull request
Apr 17, 2026
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.
Description:
This PR refines the documentation structure for the Network Operator by updating the product overview and adding the runtime architecture details.
Summary:
Expanded the Overview page with a clearer product introduction, the problems the operator solves, core concepts, and main building blocks.
Added a dedicated Architecture Overview page for the runtime flow and sequence diagrams.
Kept the original high-level resource relationship diagram, while adding two focused sequence diagrams:
Device provisioning flow
Config reconciliation flow
Updated the docs sidebar so the new architecture page is easy to discover.
Why:
Reduces duplication between the overview and architecture content.
Makes the docs easier to scan for new readers.
Separates conceptual documentation from execution-level behavior.
Notes:
This change is documentation-only.
No code behavior was modified.