release: add README.md
Browse files
README.md
CHANGED
|
@@ -1348,6 +1348,31 @@ Documentation in this repository:
|
|
| 1348 |
| [`docs/CHANGELOG.md`](docs/CHANGELOG.md) | versioned record |
|
| 1349 |
| [`MODEL_CARD.md`](MODEL_CARD.md) | the Hugging Face model card |
|
| 1350 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1351 |
## Citation
|
| 1352 |
|
| 1353 |
No paper accompanies this release. Until one exists, cite the repository:
|
|
|
|
| 1348 |
| [`docs/CHANGELOG.md`](docs/CHANGELOG.md) | versioned record |
|
| 1349 |
| [`MODEL_CARD.md`](MODEL_CARD.md) | the Hugging Face model card |
|
| 1350 |
|
| 1351 |
+
Supporting and subsystem documentation:
|
| 1352 |
+
|
| 1353 |
+
| Document | Contents |
|
| 1354 |
+
|---|---|
|
| 1355 |
+
| [`docs/SECURITY.md`](docs/SECURITY.md) | trust model, secret custody, CORS allowlist, limits, what is *not* defended |
|
| 1356 |
+
| [`docs/TESTING.md`](docs/TESTING.md) | suite inventory, the doc-guard tests, the harness false-positive lesson |
|
| 1357 |
+
| [`docs/GEOSPATIAL.md`](docs/GEOSPATIAL.md) | raster contract, CRS, the coordinate-system rule, band inference, normalisation |
|
| 1358 |
+
| [`docs/DATA_PIPELINE.md`](docs/DATA_PIPELINE.md) | asset → specialist input, cached features, sensor adapter |
|
| 1359 |
+
| [`docs/OPERATIONS.md`](docs/OPERATIONS.md) | the runbook, warming, incident triage, known operational gaps |
|
| 1360 |
+
| [`docs/DEVELOPMENT.md`](docs/DEVELOPMENT.md) | local setup, the config-hash rule, how to add a specialist, dev traps |
|
| 1361 |
+
| [`docs/PERFORMANCE.md`](docs/PERFORMANCE.md) | model footprint, measured component timings, cost traps |
|
| 1362 |
+
| [`docs/FRONTEND.md`](docs/FRONTEND.md) | the 11 pages, the Analyze console, the eight events, Cloudflare traps |
|
| 1363 |
+
| [`docs/SERVING.md`](docs/SERVING.md) | `build_space_app()`, the four endpoints, lazy loading, the G-1 trap |
|
| 1364 |
+
| [`docs/GLOSSARY.md`](docs/GLOSSARY.md) | every domain term and status vocabulary, defined |
|
| 1365 |
+
| [`docs/MASTER_ARCHITECTURE_PLAN.md`](docs/MASTER_ARCHITECTURE_PLAN.md) | the **original** master plan (historical; superseded in parts) |
|
| 1366 |
+
| [`HF_RELEASE_VERIFICATION.md`](HF_RELEASE_VERIFICATION.md) | the Hugging Face release verification record |
|
| 1367 |
+
| [`RELEASE_MANIFEST.md`](RELEASE_MANIFEST.md) | every released file with its size and sha256 |
|
| 1368 |
+
| [`tools/`](tools/) | the verification tooling (`verify_readme_metrics.py`, manifest generators, archive tools) |
|
| 1369 |
+
|
| 1370 |
+
> **Honesty rule.** Every document in this repository uses one status vocabulary —
|
| 1371 |
+
> `IMPLEMENTED` · `VERIFIED` · `MEASURED` · `ATTEMPTED` · `NOT RUN` · `BLOCKED` · `DEFERRED` ·
|
| 1372 |
+
> `REJECTED` · `OPEN` · `RESOLVED` · `CLOSED` — and negative results are recorded rather than
|
| 1373 |
+
> omitted. Where evidence was missing, the text says
|
| 1374 |
+
> `UNKNOWN — not established from the available evidence` instead of guessing.
|
| 1375 |
+
|
| 1376 |
## Citation
|
| 1377 |
|
| 1378 |
No paper accompanies this release. Until one exists, cite the repository:
|