This repository contains Vulcan documentation in markdown format.
The documentation site is generated using MkDocs and diagrams.
- Python3
- Graphviz
pip3 install -r requirements.txt
python3 diagrams/simplified-architecture.py
# The image will be created in "docs/img/simplified-architecture.png".
python3 diagrams/detailed-architecture.py
# The image will be created in "docs/img/detailed-architecture.png".pip3 install -r requirements.txt
mkdocs serve
# The site will be served in "http://127.0.0.1:8000/".
