docs: finalize P2 manuals, project state, and install-doc service contract
This commit is contained in:
@@ -16,25 +16,45 @@
|
||||
|
||||
## P2 — Host preprocessing CLI
|
||||
|
||||
**Status:** instructions to be finalized by P2 implementation; not yet runnable.
|
||||
**Status:** P2 implementation complete; automated integration PASS; manual acceptance PENDING.
|
||||
|
||||
Manual goal: from a clean local installation, use only `thothctl` on the host to inspect one
|
||||
registry workspace and execute the controlled REST-DWH/HTTP-Evidence preprocessing path without a
|
||||
host Python or Node runtime.
|
||||
host Python or Node runtime. Use a fresh operator root and a fresh fixture Git remote; never reuse
|
||||
the automated `.artifacts/p2-integration/**` state.
|
||||
|
||||
Checks to fill during P2:
|
||||
Commands (contract: `docs/contracts/workspace-preprocessing-cli.md`):
|
||||
|
||||
1. installation/render preflight;
|
||||
2. workspace inspection and exact revision display;
|
||||
3. DWH preprocessing and resume;
|
||||
4. FK machine output and manual-review checkpoint;
|
||||
5. schema check/index;
|
||||
6. HTTP Evidence dry-run and real run;
|
||||
7. idempotent rerun;
|
||||
8. filesystem Evidence stable deferred error;
|
||||
9. secret scan and exact cleanup.
|
||||
```bash
|
||||
thothctl --installation <abs>/thothii-installation.yaml workspace inspect --workspace <id> --json
|
||||
thothctl --installation <abs>/thothii-installation.yaml workspace preprocess dwh --workspace <id> --json
|
||||
thothctl --installation <abs>/thothii-installation.yaml workspace preprocess dwh --workspace <id> --resume <run-id> --json
|
||||
thothctl --installation <abs>/thothii-installation.yaml workspace schema suggest-fks --workspace <id> --from-sql <file>.sql --output <candidates>.yaml --json
|
||||
thothctl --installation <abs>/thothii-installation.yaml workspace schema check --workspace <id> --annotations <reviewed>.yaml --reviewed-candidates <sha256:hex> --json
|
||||
thothctl --installation <abs>/thothii-installation.yaml workspace index-schema --workspace <id> --json
|
||||
thothctl --installation <abs>/thothii-installation.yaml workspace preprocess evidence --workspace <id> --dry-run --json
|
||||
thothctl --installation <abs>/thothii-installation.yaml workspace preprocess evidence --workspace <id> --json
|
||||
thothctl --installation <abs>/thothii-installation.yaml workspace preprocess run --workspace <id> --json
|
||||
```
|
||||
|
||||
Decision: **PENDING**.
|
||||
Checks:
|
||||
|
||||
1. installation/render preflight (`inspect` returns exact revision + catalog/descriptor digests);
|
||||
2. DWH introspection+LSH succeeds, rerun is `unchanged`, `--resume <run-id>` is `unchanged`/`succeeded`;
|
||||
3. `schema suggest-fks` returns pristine JSON with `suggestedFksYaml` and a `manual_review_required`
|
||||
block (exit 3) when candidates exist; the suggested YAML digest equals the reported digest;
|
||||
4. `schema check --annotations <reviewed> --reviewed-candidates <digest>` succeeds after review;
|
||||
5. `index-schema` counts against a pre-provisioned compatible collection and rerun is `unchanged`;
|
||||
6. HTTP Evidence `--dry-run` returns `dry_run`, the real run publishes, rerun is `unchanged`, an input
|
||||
mutation produces a new generation/ACTIVE;
|
||||
7. filesystem Evidence returns a stable `evidence_materialization_required` block with no partial
|
||||
corpus/vector publication;
|
||||
8. negatives: missing workspace (`workspace_not_activatable`), resume of a nonexistent run
|
||||
(`preprocessing_resume_mismatch`), invalid annotations digest (`annotation_invalid`), no-Evidence
|
||||
skip warning, no collection creation, no backend/Pi/frontend listener;
|
||||
9. secret scan over retained artifacts and exact owned-resource cleanup.
|
||||
|
||||
Decision: **PENDING** (independent manual gate; automation never records PASS).
|
||||
|
||||
## P3 — Effective config and `.tht-dwh`
|
||||
|
||||
|
||||
Reference in New Issue
Block a user