FullStaQD Reference Architecture

⚠️ Warning: The architecture and its documentation are still an early draft.

This repository contains the arc42-based documentation for the FullStaQD reference architecture. We use Material for MKDocs to host our markdown-based documentation as a website. We would love your input on the architecture, please reach out via the Issue Tracker!

Local Development

source ./.venv/bin/activate
mkdocs serve --livereload

Deployment

The deployment of this documentation site is automated with GitHub Actions. You can find the deployment workflow in the .github/workflows/deploy-pages.yml file. The documentation site can be build manually as follows to be deployed to any web server capable of hosting HTML, CSS and JS files:

source ./.venv/bin/activate
mkdocs build