This directory holds the authoritative technical documentation for QuakeGuard, authored in Typst and compiled into a single PDF technical report.
| File | Covers |
|---|---|
main.typ |
Document setup, cover page, table of contents (compiles all chapters) |
01-architecture.typ |
System architecture & high-level topology (edge / backend / client) |
02-hardware.typ |
ESP32-C3 edge node: DSP, STA/LTA, FreeRTOS, optional GNSS subsystem |
03-security.typ |
ECDSA identity, provisioning handshake, payload authentication |
04-broker.typ |
MQTT data plane, Eclipse Mosquitto, internal MQTT bridge |
05-backend.typ |
Redis Streams ingestion, worker, TimescaleDB, geo-zoning, alerts |
06-mobile.typ |
React Native client: per-zone seismograph, GPS zone detection, themes |
07-deployment.typ |
Local/development provisioning, scaling, simulation & stress testing |
08-ai.typ |
On-premise AI Emergency Report service (Ollama) |
09-devops.typ |
DevOps, CI/CD pipelines, and infrastructure orchestration |
09-triangulation.typ |
Epicenter triangulation algorithm and multi-node correlation |
10-benchmarks.typ |
Performance benchmarks and load testing results |
11-limitations.typ |
Known limitations and future mitigations |
12-roadmap.typ |
Version roadmap and future horizons |
13-threat-model.typ |
Threat model and security analysis |
14-bibliography.typ |
References and bibliography |
15-glossary.typ |
Technical glossary |
16-appendix.typ |
Appendix: schematics, data tables, and supplementary material |
Note: The assets/ directory contains logos and color palettes used by the report.
Requires Typst (typst on PATH) and the Liberation Serif font family.
cd docs/whitepaper
typst compile main.typ QuakeGuard_Technical_Report_v2.1.1.pdfThe output PDF is a local build artifact and is intentionally not tracked in git.
- Chapters are plain Typst with
[cite: 1]markers that reference the originalcodebase_docs.txtsource export (seeextract.sh). - Keep each chapter self-contained; the build order is defined in
main.typvia#include. - When a new release changes behaviour, update the affected chapters and bump the version string in
main.typ(cover + page header) to match.
extract.sh compiles the entire QuakeGuard codebase into a single codebase_docs.txt file for LLM context. Run it from this directory when you need a fresh export:
cd docs
./extract.sh