Open
Conversation
Signed-off-by: Daniël Kok <daniel.kok@alliander.com>
Mermaid does not offer any way to break up long lines, so I need to work with lines longer that 120 characters for now. The C4 functionality is in active development, so I hope to see some changes for this in the future. Signed-off-by: Daniël Kok <daniel.kok@alliander.com>
The System() seems to be broken with formatting. Since we need a simple diagram for now I will swap to System() instead. Signed-off-by: Daniël Kok <daniel.kok@alliander.com>
Signed-off-by: Daniël Kok <daniel.kok@alliander.com>
Signed-off-by: Daniël Kok <daniel.kok@alliander.com>
Signed-off-by: Daniël Kok <daniel.kok@alliander.com>
Signed-off-by: Daniël Kok <daniel.kok@alliander.com>
Signed-off-by: Daniël Kok <daniel.kok@alliander.com>
Signed-off-by: Daniël Kok <daniel.kok@alliander.com>
Signed-off-by: Daniël Kok <daniel.kok@alliander.com>
Signed-off-by: Daniël Kok <daniel.kok@alliander.com>
Signed-off-by: Daniël Kok <daniel.kok@alliander.com>
Signed-off-by: Daniël Kok <daniel.kok@alliander.com>
Signed-off-by: Daniël Kok <daniel.kok@alliander.com>
Signed-off-by: Daniël Kok <daniel.kok@alliander.com>
Signed-off-by: Daniël Kok <daniel.kok@alliander.com>
Signed-off-by: Daniël Kok <daniel.kok@alliander.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the architecture documentation to use the C4 model methodology, replacing the outdated state diagram with comprehensive Container and Component diagrams that better represent the current system structure.
Changes:
- Replaced state diagram with C4 Container diagram showing system boundaries and relationships
- Added three Component diagrams (Thermal Modeling, Toolbox, Docs) detailing internal structures
- Removed outdated warning message about documentation status
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| title C2: Containers of the Transformer Thermal Model | ||
|
|
||
| Person_Ext(scientist, "Scientist", "Someone that reports on or analyses thermals of transformers.") | ||
| System_Ext(cyclops, "Cyclic Optimiser", "Finds a thermal limit of a transformer by repeatedly calculating<br/> the thermals and scaling a load profile.") |
There was a problem hiding this comment.
Corrected spelling of 'Optimiser' to 'Optimizer'.
Suggested change
| System_Ext(cyclops, "Cyclic Optimiser", "Finds a thermal limit of a transformer by repeatedly calculating<br/> the thermals and scaling a load profile.") | |
| System_Ext(cyclops, "Cyclic Optimizer", "Finds a thermal limit of a transformer by repeatedly calculating<br/> the thermals and scaling a load profile.") |
| title C3: Thermal Modeling | ||
|
|
||
| Person_Ext(scientist, "Scientist", "Someone that reports on or analyses thermals of transformers.") | ||
| System_Ext(cyclops, "Cyclic Optimiser", "Finds a thermal limit of a transformer by repeatedly calculating<br/> the thermals and scaling a load profile.") |
There was a problem hiding this comment.
Corrected spelling of 'Optimiser' to 'Optimizer'.
LunaJansma
reviewed
Feb 2, 2026
Contributor
LunaJansma
left a comment
There was a problem hiding this comment.
De branch moet nog bijgewerkt worden. Verder goedgekeurd, ziet er duidelijk uit.
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
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
The goal was to update the architecture to reflect the new features added in the past. Also, since we want to use the C4 method now, it was the right time to rewrite this page.
Generated example
When I run
poetry run mkdocs serve, I get the following now:What I ran into
TransformerComponentdiagram is not added, because that is a level to deep.