0ff55f5e9c
Moves documentation into the code repo so code, docs, and diagrams version-lock and review together. Previous location was pumpingStation.wiki.git; that will shrink to a pointer. Contents: - wiki/README.md — doc index - wiki/functional-description.md — operator-facing reference derived from src/specificClass.js: basin model, net-flow selection, level-based control zones, safety interlocks, registration topology - wiki/diagrams/ — editable draw.io sources paired with SVG exports (basin-model, control-zones, safety-rules) + README with the open/edit/export/commit workflow The .drawio files are rough starters; iterate in draw.io and re-export. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Diagrams
Editable source diagrams for the pumpingStation wiki. Each diagram is a .drawio + .drawio.svg pair, so anyone can edit the source in draw.io without touching any Markdown.
Why two files?
| File | Role |
|---|---|
<name>.drawio |
Native draw.io XML. The canonical source. |
<name>.drawio.svg |
SVG export of the same diagram (with source embedded). What the wiki actually renders, and what round-trips back into draw.io. |
Checking both in means the wiki renders for everyone, and the next editor picks up from exactly where the last one left off.
Editing workflow
- Clone the repo (you likely already have it if you're editing):
git clone https://gitea.wbd-rd.nl/RnD/pumpingStation.git cd pumpingStation/wiki/diagrams - Open the
.drawiofile in draw.io:- Web: app.diagrams.net → Open Existing Diagram, or drag-and-drop.
- Desktop: drawio-desktop.
- Edit — move shapes, change labels, adjust layout.
- Export to SVG with the source embedded:
File → Export as → SVG…- Check Include a copy of my diagram ← this is what lets future edits round-trip through the SVG.
- Save next to the source as
<name>.drawio.svg(overwrite).
- Commit & push both files:
git add wiki/diagrams/<name>.drawio wiki/diagrams/<name>.drawio.svg git commit -m "Update <name>: <what changed>" git push
Referencing a diagram from a wiki page
In any Markdown page under wiki/:
Use a descriptive alt text; it's the fallback if the SVG fails and it shows up in exports.
Naming
- kebab-case, one concept per diagram.
- Current diagrams:
| Diagram | Shows |
|---|---|
basin-model |
Physical basin cross-section — walls, pipes at their real heights, control thresholds cutting across, zone labels |
control-zones |
Vertical level axis ("thermometer") for levelbased mode — STOP / DEAD ZONE / RUN with demand ramp |
safety-rules |
Dry-run vs overfill rule asymmetry — which children stop, which keep running |
Making a brand-new diagram
- Open draw.io, start blank.
- Draw it.
File → Save As…→wiki/diagrams/<name>.drawio.File → Export as → SVG…with Include a copy of my diagram checked → save aswiki/diagrams/<name>.drawio.svg.- Reference from the wiki page with
. - Add an entry to the table above.
- Commit all three files together (
.drawio,.drawio.svg, updated.md).
These starters are rough
The .drawio files committed here by Claude are placeholders — layout is approximate, colors and fonts are defaults, no fine alignment. They compile to a valid SVG you can see rendered on the page, but they're meant to be a starting point. Open them in draw.io, refine the layout, re-export.