feat: add architecture overview page with Mermaid diagram#43
Open
lbajsarowicz wants to merge 1 commit intowardenenv:mainfrom
Open
feat: add architecture overview page with Mermaid diagram#43lbajsarowicz wants to merge 1 commit intowardenenv:mainfrom
lbajsarowicz wants to merge 1 commit intowardenenv:mainfrom
Conversation
Add visual architecture diagram showing Warden's three service layers: - Host Services (CLI, Docker Engine, Mutagen, SSL Root CA) - Global Docker Services (Traefik, DNSmasq, Mailpit, SSH Tunnel, phpMyAdmin, Portainer) - Per-Project Docker Services (Nginx, PHP-FPM, DB, Redis, ES, RabbitMQ, Varnish) Uses Mermaid rendered via sphinxcontrib-mermaid during Sphinx build. Includes service tables with toggle flags and optional service descriptions.
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.
Summary
sphinxcontrib-mermaidextension for rendering Mermaid diagrams during Sphinx build.venvfrom Sphinx build in.gitignoreandconf.pyThe architecture page documents Warden's three service layers with:
Architecture Diagram Preview
flowchart TB classDef default fill:#ffffff,stroke:#3f51b5,stroke-width:1.5px,color:#000000,font-weight:bold,font-size:12px; subgraph DevSys ["Developer's System"] direction TB subgraph Host ["Host Services"] direction LR h1["Warden CLI"] ~~~ h2["Docker Engine"] ~~~ h3["Mutagen File Sync"] ~~~ h4["Trusted SSL Root CA"] end subgraph Global ["Global Docker Services — warden svc up"] direction LR g1["Traefik<br>Reverse Proxy + SSL"] ~~~ g2["DNSmasq"] ~~~ g3["Mailpit<br>Email Catcher"] ~~~ g4["SSH Tunnel"] ~~~ g5["phpMyAdmin"] ~~~ g6["Portainer"] end subgraph Project ["Per-Project Docker Services — warden env up"] direction LR p1["Nginx"] ~~~ p2["PHP-FPM"] ~~~ p3["MariaDB / MySQL"] ~~~ p4["Redis / Valkey"] ~~~ p5["Elasticsearch /<br>OpenSearch"] ~~~ p6["RabbitMQ"] ~~~ p7["Varnish"] end Host ~~~ Global ~~~ Project end style DevSys fill:#f5f5f5,stroke:#666666,stroke-width:1px,rx:8,ry:8 style Host fill:transparent,stroke:none style Global fill:#fff3e0,stroke:#FF9800,stroke-width:1px,rx:8,ry:8 style Project fill:#e8f5e9,stroke:#4CAF50,stroke-width:1px,stroke-dasharray: 5 5,rx:8,ry:8Test plan
pip install -r requirements.txt && make html— verifyarchitecture.htmlrenders the Mermaid diagram⭐ Support my work
Do you like the fix? Remember to react with "👍🏻" to get it merged faster,
Then Sponsor me on Github so I can spend more time on fixing issues like this one.
Learn more at https://github.com/sponsors/lbajsarowicz