jobe/aquacom-gateway-suite
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

📝 Documenation

Browse Source
This commit is contained in:
Jonas Bengtsson
2026-10-06 07:08:03 +02:00
parent 08d44babbb
commit e1f51772da
12 changed files with 17511 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files
missing_docs.md
+7 -9
View File
@@ -6,10 +6,7 @@ Referenced from: `AGENTS.md`, `ARCHITECTURE.md`, `docs/product/codex-implementat
## Root
| Document | Referenced for | Source of reference |
|---|---|---|
| `README.md` | Repository overview; required by the repository structure (§5) | codex-implementation-specification.md §5 |
| `CHANGELOG.md` | Version history; required by the repository structure (§5) | codex-implementation-specification.md §5 |
**Status 2026-10-06:** all root documents exist (`README.md`, `CHANGELOG.md`). No root documents are missing.
## docs/architecture/
@@ -29,12 +26,11 @@ Referenced by `ARCHITECTURE.md` (§1) and the repository structure (§5).
Referenced by `AGENTS.md` (protocol-evidence and uncertainty rules), `ARCHITECTURE.md` (§54), `software-specification.md` (§5.1), and the repository structure (§5).
**Status 2026-10-05:** The authoritative source is present (`AquaCom_RTU_1_6_eng.pdf` + markdown conversion), and the gap registry (`protocol-gaps.md`), operations registry (`known-operations.md`), and test-vector catalogue (`test-vectors.md`) have been created from it. Only the curated knowledge base remains:
| Document | Referenced for | Priority |
|---|---|---|
| `docs/protocol/aquacom.md` | Authoritative AquaCom protocol knowledge base | High — blocks Phase 3+ implementation |
| `docs/protocol/known-operations.md` | Registry of verified AquaCom operations | High |
| `docs/protocol/protocol-gaps.md` | **Protocol-gap registry.** Every unresolved AquaCom protocol question shall be recorded here; the evidence rules in `AGENTS.md` and the implementation spec are not executable without it. | **Highest — create first** |
| `docs/protocol/test-vectors.md` | Approved protocol test vectors for implemented telegram types | High — required by every implemented telegram type |
| `docs/protocol/aquacom.md` | Curated AquaCom protocol knowledge base — to be derived from `AquaCom_RTU_1_6_eng.md` (framing, checksum, timeout, transport and encoding rules currently live in the other three files and the source document) | Medium — consolidation work, no longer an evidence blocker |
## docs/operations/
@@ -56,6 +52,8 @@ Referenced by `AGENTS.md` and codex-implementation-specification.md §59.
| `docs/exec-plans/active/` | Active ExecPlans for substantial work |
| `docs/exec-plans/completed/` | Completed ExecPlans |
**Status 2026-10-06:** `docs/exec-plans/active/001-implementation-roadmap.md` exists (umbrella roadmap: phases 0–14, gates, gap-consumption schedule, decisions log). Child ExecPlans are spawned from it per §59 as substantial work begins; `completed/` is created when the first plan finishes.
## Schemas
Referenced by `configuration-reference.md` §1 and the repository structure (§5). Extensions depend on the configuration format chosen during technology selection.
@@ -72,5 +70,5 @@ Referenced by `configuration-reference.md` §1 and the repository structure (§5
## Notes
- The directories `docs/architecture/` and `docs/protocol/` already exist but are empty; `docs/operations/`, `docs/exec-plans/` and `schemas/` do not exist yet.
- `protocol-gaps.md` deserves priority: the architecture's evidence rules direct unresolved protocol questions into it, so its absence would leave the first such question with nowhere to go. Creating an empty registry with the entry template from codex-implementation-specification.md §17 is sufficient to start.
- `protocol-gaps.md` now exists and is seeded (10 entries: 1 conversion-fidelity `VERIFY`, 9 `OPEN`). Unresolved AquaCom protocol questions continue to be recorded there; closing an entry requires evidence and a dated resolution note.
- ExecPlan directory contents are created on demand as substantial work begins; an empty directory is the normal state.