Skip to content

Commit 0bcaccb

Browse files
committed
docs(fullstack): single-repo docs hub, docs/web page and GitHub Pages sync
- Move whitepaper Typst sources into docs/whitepaper/ - Add docs/web/ as single source of truth for the QuakeGuard page - Bump page content to v1.2.1 (Geo-Zoning & GNSS-Ready) in EN/IT dicts - Update release.svg badge to v1.2.1 - Add deploy-gh-pages.yml workflow syncing docs/web to GiZano.github.io
1 parent 5347235 commit 0bcaccb

52 files changed

Lines changed: 1648 additions & 21 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
name: Deploy QuakeGuard Page to GitHub Pages Repo
2+
3+
on:
4+
push:
5+
branches: [ "main" ]
6+
paths:
7+
- 'docs/web/**'
8+
- '.github/workflows/deploy-gh-pages.yml'
9+
workflow_dispatch:
10+
11+
jobs:
12+
sync-pages:
13+
name: Sync docs/web → GiZano.github.io
14+
runs-on: ubuntu-latest
15+
16+
steps:
17+
- name: Checkout QuakeGuard
18+
uses: actions/checkout@11d5960a326750d5838078e36cf38b85af677262
19+
20+
- name: Checkout GiZano.github.io (site repo)
21+
uses: actions/checkout@11d5960a326750d5838078e36cf38b85af677262
22+
with:
23+
repository: GiZano/GiZano.github.io
24+
ref: main
25+
token: ${{ secrets.GIZANO_IO_PAT }}
26+
path: site-repo
27+
28+
- name: Copy QuakeGuard page artifacts
29+
run: |
30+
cp docs/web/quakeguard.html site-repo/projects/quakeguard.html
31+
cp docs/web/quakeguard.css site-repo/Style/quakeguard.css
32+
cp docs/web/quakeguard.js site-repo/Script/i18n/quakeguard.js
33+
cp docs/web/quakeguard-demo.js site-repo/Script/quakeguard-demo.js
34+
cp -r docs/web/assets/quakeguard/. site-repo/assets/quakeguard/
35+
cp -r docs/web/assets/badges/. site-repo/assets/badges/
36+
37+
- name: Commit and push if changed
38+
run: |
39+
cd site-repo
40+
git config user.name "github-actions[bot]"
41+
git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
42+
43+
if git diff --quiet; then
44+
echo "No changes to deploy — skipping commit."
45+
exit 0
46+
fi
47+
48+
git add -A
49+
git commit -m "docs(quakeguard): sync v1.2.1 page from QuakeGuard repo"
50+
git push origin main

.gitignore

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,11 @@
77
# ------------------------------------------
88
.env
99

10+
# ------------------------------------------
11+
# Project Notes (local tracker, not part of the repo)
12+
# ------------------------------------------
13+
TODO.md
14+
1015
# ------------------------------------------
1116
# Python (Backend)
1217
# ------------------------------------------

docs/README.md

Lines changed: 22 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,39 @@
11
# QuakeGuard — Documentation Hub
22

3-
This directory holds the authoritative technical documentation for QuakeGuard, authored in [Typst](https://typst.app/) and compiled into a single PDF technical report.
3+
Single source of truth for QuakeGuard documentation. Each subfolder has a single
4+
purpose:
5+
6+
```
7+
docs/
8+
├── whitepaper/ # main.typ + 01-architecture..08-ai.typ + assets/ + PDF
9+
├── web/ # quakeguard.html/css/js/demo.js + assets/ (see README)
10+
├── README.md # this hub guide
11+
├── extract.sh # LLM context export (stays at docs/ root)
12+
└── codebase_docs.txt # generated by extract.sh (stays at docs/ root)
13+
```
414

515
## Contents
616

7-
| File | Covers |
8-
|------|--------|
9-
| `main.typ` | Document setup, cover page, table of contents (compiles all chapters) |
10-
| `01-architecture.typ` | System architecture & high-level topology (edge / backend / client) |
11-
| `02-hardware.typ` | ESP32-C3 edge node: DSP, STA/LTA, FreeRTOS, optional GNSS subsystem |
12-
| `03-security.typ` | ECDSA identity, provisioning handshake, payload authentication |
13-
| `04-broker.typ` | MQTT data plane, HiveMQ Cloud, internal MQTT bridge |
14-
| `05-backend.typ` | Redis Streams ingestion, worker, TimescaleDB, geo-zoning, alerts |
15-
| `06-mobile.typ` | React Native client: per-zone seismograph, GPS zone detection, themes |
16-
| `07-deployment.typ` | Local/development provisioning, scaling, simulation & stress testing |
17-
| `08-ai.typ` | On-premise AI Emergency Report service (Ollama) |
18-
| `assets/` | Logos and color palette used by the report |
19-
20-
## Compiling the PDF
17+
| Directory | Covers |
18+
|-----------|--------|
19+
| [`whitepaper/`](whitepaper/README.md) | Typst sources for the technical report, compiled into `QuakeGuard_Technical_Report_v1.2.1.pdf` |
20+
| [`web/`](web/) | QuakeGuard page artifacts (html/css/js/demo + assets) synced to the `GiZano.github.io` Pages site via CI |
21+
22+
## Compiling the whitepaper PDF
2123

2224
Requires [Typst](https://typst.app/) (`typst` on PATH) and the Liberation Serif font family.
2325

2426
```bash
2527
cd docs
26-
typst compile main.typ QuakeGuard_Technical_Report_v1.2.1.pdf
28+
typst compile whitepaper/main.typ whitepaper/QuakeGuard_Technical_Report_v1.2.1.pdf
2729
```
2830

2931
The output PDF is a local build artifact and is intentionally **not** tracked in git.
3032

31-
## Editing conventions
33+
## Editing the web page
3234

33-
- Chapters are plain Typst with `[cite: 1]` markers that reference the original `codebase_docs.txt` source export (see `extract.sh`).
34-
- Keep each chapter self-contained; the build order is defined in `main.typ` via `#include`.
35-
- When a new release changes behaviour, update the affected chapters and bump the version string in `main.typ` (cover + page header) to match.
35+
Edit only inside `docs/web/`. A CI workflow (`deploy-gh-pages.yml`) syncs changes
36+
into the `GiZano/GiZano.github.io` Pages repo; never edit the site repo directly.
3637

3738
## `extract.sh`
3839

@@ -41,4 +42,4 @@ The output PDF is a local build artifact and is intentionally **not** tracked in
4142
```bash
4243
cd docs
4344
./extract.sh
44-
```
45+
```

docs/web/assets/badges/license.svg

Lines changed: 1 addition & 0 deletions
Loading

docs/web/assets/badges/release.svg

Lines changed: 1 addition & 0 deletions
Loading
Lines changed: 35 additions & 0 deletions
Loading
File renamed without changes.
698 KB
Loading
269 KB
Loading
205 KB
Loading

0 commit comments

Comments
 (0)