Describe the code the docs actually ship with (B-68)
CLAUDE.md and README still asserted a state the code had moved past: - JWT "no revocation (B-34)" — token_version implements exactly that revocation, and the tv-claim behaviour (including why the deploy did not log everyone out) is worth stating instead of denying; - /report-bug "a placeholder" — it shipped fully implemented and translated, with an admin triage section, a reporter-side status view and its own audit event; only /guida is still a stub, and /admin has six sections now, not five; - three stale test counts (CLAUDE.md twice, README once); - a code map missing app/auth/rate_limit.py, app/api/client_ip.py and app/api/routes/bug_reports.py; - README linking flowchart.mmd (the diagrams live in flowchart/), the anchor CLAUDE.md#tech-stack-mvp (gone), and describing docs/running-the-server.md as "local venv vs. Docker" after B-44 made Docker the only supported way to run the server. The rate-limiting bullet the audit also flagged already reads correctly. tests/unit/test_docs_current.py pins all of it: the documented counts must equal what the suite actually collects, the retired claims must stay retired, the code map must name those modules, and every relative README link and CLAUDE.md anchor must resolve. None of this is catchable by reading the code, which is how it drifted in the first place. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
This commit is contained in:
@@ -41,9 +41,9 @@ domain).
|
||||
## Documentation
|
||||
|
||||
- [CLAUDE.md](CLAUDE.md) — architecture, commands, domain decisions, known gaps (for anyone/anything working on the code)
|
||||
- [flowchart.mmd](flowchart.mmd) — the source-of-truth flow diagram the implementation follows node-by-node
|
||||
- [flowchart/](flowchart/) — the source-of-truth flow diagrams the implementation follows node-by-node: [platform-overview.mmd](flowchart/platform-overview.mmd) (the 5-phase flow) and [round-lifecycle.mmd](flowchart/round-lifecycle.mmd) (the round/draw lifecycle)
|
||||
- [docs/setup.md](docs/setup.md) — one-time setup (secrets, master key, migrations)
|
||||
- [docs/running-the-server.md](docs/running-the-server.md) — how to launch it (local venv vs. Docker+Caddy, dev vs. production TLS)
|
||||
- [docs/running-the-server.md](docs/running-the-server.md) — how to launch it with Docker+Caddy (dev vs. production TLS)
|
||||
- [docs/guida-utente.md](docs/guida-utente.md) — end-user guide to the test UI (Italian)
|
||||
- [docs/guida-admin.md](docs/guida-admin.md) — admin dashboard guide (Italian)
|
||||
|
||||
@@ -51,7 +51,7 @@ domain).
|
||||
|
||||
Python (FastAPI, SQLAlchemy async + Alembic, Argon2 + JWT auth), Electrum
|
||||
protocol for PLM network access (no full node), Docker + Caddy for
|
||||
deployment. See [CLAUDE.md](CLAUDE.md#tech-stack-mvp) for the complete list
|
||||
deployment. See [CLAUDE.md](CLAUDE.md#tech-stack) for the complete list
|
||||
and the reasoning behind each choice.
|
||||
|
||||
## Testing
|
||||
@@ -61,7 +61,7 @@ python -m pytest # all tests
|
||||
python -m pytest tests/unit/test_hd.py # one file
|
||||
```
|
||||
|
||||
232 unit tests cover HD derivation, PSBT building, the Electrum client, bets,
|
||||
345 unit tests cover HD derivation, PSBT building, the Electrum client, bets,
|
||||
deposits, withdrawals, the round/draw engine, RBF fee-bumping, admin config,
|
||||
the pending-inclusive balance calculation, and the SSE push channel. No
|
||||
automated integration tests against a live Electrum connection — mainnet
|
||||
|
||||
Reference in New Issue
Block a user