docs: applications: replace mermaid diagrams with rendered PlantUML - #97
Closed
simensrostad wants to merge 1 commit into
Closed
simensrostad wants to merge 1 commit into
simensrostad wants to merge 1 commit into
Conversation
Swap the mermaid state/module diagrams for PlantUML sources rendered to SVG, since the diagrams need to describe implementations exactly (entry/exit actions, guards, ignored events) which mermaid couldn't express well. Adds `doc/diagrams/` sources and SVGs for 91m1_ppp, 93m1_ppp and 93m1_at, a shared notation table in the 91m1_ppp architecture guide, new `state-machines.md` docs for the 93m1 apps, and `scripts/render_diagrams.py` to regenerate the SVGs from a PlantUML server. Also fixes a small Location module bug in the docs (reject on `location_request()` failure) and documents the render workflow in `doc/ci-and-contribution.md`. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Signed-off-by: Simen S. Røstad <simen.rostad@nordicsemi.no>
simensrostad
force-pushed
the
add-proper-diagrams
branch
from
September 11, 2026 10:52
eb93808 to
249c250
Compare
simensrostad
marked this pull request as draft
September 11, 2026 11:33
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
1 participant
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.
Swap the mermaid state/module diagrams for PlantUML sources rendered to SVG, since the diagrams need to describe implementations exactly (entry/exit actions, guards, ignored events) which mermaid couldn't express well. Adds
doc/diagrams/sources and SVGs for 91m1_ppp, 93m1_ppp and 93m1_at, a shared notation table in the 91m1_ppp architecture guide, newstate-machines.mddocs for the 93m1 apps, andscripts/render_diagrams.pyto regenerate the SVGs from a PlantUML server. Also fixes a small Location module bug in the docs (reject onlocation_request()failure) and documents the render workflow indoc/ci-and-contribution.md.