2 Commits

Include renames

Author	SHA1	Message	Date
2GT-RichandClaude Opus 5	98a72e1f7a	docs: versioned documentation site, and the four pages that were missing (v0.23.28-beta) ... Closes #112. Source stays `docs/*.md`, rendered by MkDocs-Material and published to GitHub Pages by Actions. Same repository on purpose: documentation drifts, and co-location is the only thing that reliably prevents it — the pull request that changes behaviour changes the description, and review sees both. A separate repo would double the ceremony and guarantee divergence. The markdown remains readable when browsing the repository, so the site renders those files rather than replacing them. **Versioned from the start**, using mike. Images are published to GHCR and this project ships betas most days, so readers are routinely running something other than the newest build; a single "latest" would confidently describe a release they do not have. Versions follow the product rather than the docs, so the site and the running image carry the same number. **Content came first, and it had to.** The docs were eleven days and sixteen releases stale — SSH keys, bulk commands, the data-cap SMS, poller health and the timezone setting appeared in exactly zero files between them. Publishing that would have given documentation missing five of the most consequential features a polished, authoritative home, and a well-presented wrong answer is worse than an obviously rough one. Four pages now cover them: - cellular.md — signal grading, carrier aggregation, the uplink anchor, observed bands, and the data-cap SMS including why it fires early and how to calibrate the margin - ssh-keys.md — leading with what installing a key costs, because RouterOS disables password SSH for that user and the database becomes load-bearing - commands.md — why waves exist, and why reading output matters when RouterOS reports failure in text rather than an exit code - scaling.md — headroom, why it is insufficient on its own, and every tunable Pull requests build the site with `--strict`, which turns warnings into errors. That is the point of running it there at all, and it earned itself immediately: the first build failed on two links to the project README, which sits outside the docs tree. They are absolute now, so they resolve both in the rendered site and when reading the markdown on GitHub. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>	2026-09-02 18:42:40 -07:00
2GT-RichandClaude Opus 5	e10f7ba568	docs: split reference material into docs/, keeping the README a shop window (v0.23.4-beta) ... Documentation only — no functional change. The README was carrying two jobs for two different readers. Its Reference section was the single largest block at 154 lines, and nobody deciding whether to try the project reads an InfluxDB environment variable table — while the people who need it were scrolling past the pitch to reach it. Split along that seam: anything you would read before installing stays in the README, anything you would read after installing moves to docs/. README.md 430 lines sell, prove, install, feature overview docs/change-guard.md 193 safety system, settings, guard states docs/architecture.md 116 data stores, polling model, module layout docs/capsman.md 84 role model, radio matching, current limits docs/alerting.md 81 rules, channels, webhooks, maintenance windows docs/api.md 77 scoped tokens, preflight, scripting docs/configuration.md 76 environment, secrets, rotation, TLS docs/sso-oidc.md 71 identity provider setup and behaviour docs/README.md 20 index In-repo rather than a documentation site, deliberately. A change to Change Guard's semantics can edit its documentation in the same commit as the code — which, given how often that behaviour has been refined recently, is the property that actually matters. A static site generator can point at docs/ later without moving a file. The Change Guard pitch stays on the front page: the problem framing, the verified recovery timeline and the quoted prediction warning are what make someone care, and a reference page is the wrong home for them. Three sections are new rather than relocated, written because the split exposed the gaps: - architecture.md did not exist. It now records why there are three data stores, the polling cadences, and which modules are pure functions over a snapshot and why. - Scoped API tokens shipped without usage documentation. api.md shows preflighting a change from a script and reading the guard block afterwards. - change-guard.md records why ip-on-bridge-port is informational rather than critical on RouterOS 7 — reasoning that previously existed only in a commit message. Every internal anchor and cross-file link verified to resolve, including anchors into other documents. No content dropped, checked by keyword comparison against the previous single file. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>	2026-08-21 12:26:18 -07:00