35 lines
847 B
Markdown
35 lines
847 B
Markdown
# Mitus — Documentation
|
|
|
|
## View
|
|
|
|
```
|
|
cd docs && python3 -m http.server 8000
|
|
```
|
|
|
|
Then open <http://localhost:8000> in a browser.
|
|
|
|
## Re-render diagrams
|
|
|
|
After editing any `graphs/*.dot` file:
|
|
|
|
```
|
|
./render.sh
|
|
```
|
|
|
|
Requires `graphviz` (`sudo apt install graphviz`).
|
|
|
|
## Layout
|
|
|
|
```
|
|
docs/
|
|
├── index.html main page (overview, diagrams, walkthroughs)
|
|
├── viewer.html pan/zoom viewer for individual SVGs
|
|
├── render.sh regenerate all SVGs from .dot sources
|
|
└── graphs/
|
|
├── system.{dot,svg} top-level architecture
|
|
├── python_pipeline.{dot,svg} Python transport (default)
|
|
├── rust_client.{dot,svg} Rust client (sender)
|
|
├── rust_server.{dot,svg} Rust server (receiver)
|
|
└── crates.{dot,svg} Rust workspace crates
|
|
```
|