mbox series

[v2,0/5] dev-manual/devtool: ide-sdk doc rewrite and Mermaid diagrams

Message ID 20260924192929.907566-1-adrian.freihofer@siemens.com
Headers show
Series dev-manual/devtool: ide-sdk doc rewrite and Mermaid diagrams | expand

Message

Freihofer, Adrian Sept. 24, 2026, 7:29 p.m. UTC 
From: Adrian Freihofer <adrian.freihofer@siemens.com>

Update the "devtool ide-sdk" section to reflect its current behavior,
and fix outdated non-patch local file handling docs (5.1 change).

Add the sphinxcontrib-mermaid Sphinx extension, add workflow/
architecture diagrams for "devtool ide-sdk", and convert the existing
devtool add/modify/upgrade flow chart PNGs to Mermaid too.

Diagrams render client-side via a CDN-hosted mermaid.js, so the build
server needs no new dependency.

Adrian Freihofer (5):
  dev-manual/devtool: fix non-patch local file handling docs
  dev-manual/devtool: update devtool ide-sdk section for recent features
  conf.py: support mermaid plugin
  dev-manual/devtool: add Mermaid diagrams for the ide-sdk workflow and
    architecture
  dev-manual/devtool: convert add/modify/upgrade flow diagrams to
    Mermaid

 documentation/Pipfile                         |    1 +
 documentation/conf.py                         |    6 +
 documentation/dev-manual/devtool.rst          | 1026 +++++++++++------
 .../dev-manual/figures/devtool-add-flow.mmd   |   73 ++
 .../dev-manual/figures/devtool-add-flow.png   |  Bin 181699 -> 0 bytes
 .../figures/devtool-ide-sdk-architecture.mmd  |   53 +
 .../devtool-ide-sdk-nfs-architecture.mmd      |   58 +
 .../figures/devtool-ide-sdk-workflow.mmd      |   43 +
 .../figures/devtool-modify-flow.mmd           |   77 ++
 .../figures/devtool-modify-flow.png           |  Bin 171676 -> 0 bytes
 .../figures/devtool-upgrade-flow.mmd          |   52 +
 .../figures/devtool-upgrade-flow.png          |  Bin 138917 -> 0 bytes
 .../sphinx-static/theme_overrides.css         |   17 +
 13 files changed, 1046 insertions(+), 360 deletions(-)
 create mode 100644 documentation/dev-manual/figures/devtool-add-flow.mmd
 delete mode 100644 documentation/dev-manual/figures/devtool-add-flow.png
 create mode 100644 documentation/dev-manual/figures/devtool-ide-sdk-architecture.mmd
 create mode 100644 documentation/dev-manual/figures/devtool-ide-sdk-nfs-architecture.mmd
 create mode 100644 documentation/dev-manual/figures/devtool-ide-sdk-workflow.mmd
 create mode 100644 documentation/dev-manual/figures/devtool-modify-flow.mmd
 delete mode 100644 documentation/dev-manual/figures/devtool-modify-flow.png
 create mode 100644 documentation/dev-manual/figures/devtool-upgrade-flow.mmd
 delete mode 100644 documentation/dev-manual/figures/devtool-upgrade-flow.png