Clean up roadmap and troubleshooting documentation

This commit is contained in:
2026-08-01 18:16:01 +00:00
parent 1250247986
commit 7d591487e4
11 changed files with 21 additions and 1671 deletions

View File

@@ -3,8 +3,7 @@
This guide covers normal operation, managed workspace state, inspection,
recovery, and operational caveats. See the [CLI reference](cli.md) for complete
command syntax and the [configuration reference](config.md) for fields,
defaults, and notification templates. For symptom-based diagnosis, see
[Troubleshooting](troubleshooting.md).
defaults, and notification templates.
## Normal Operation
@@ -19,8 +18,8 @@ persists the module snapshot and prompt data package, records Promptkit
preparation provenance before provider execution, then persists raw output and
execution provenance, validates the structured generated text, and renders the
managed Markdown report from the validated text and deterministic values.
The current receipts are transitional workspace state, not a cross-version
profile-provenance contract.
These receipts describe the current workspace implementation; they are not a
cross-version profile-provenance contract.
The managed report and its final metadata are saved before single-report
Distributor notification is attempted. `--out` writes an extra operator copy;
@@ -48,8 +47,9 @@ Prompt inspection occurs before weather collection. A malformed profile file,
missing required credential, or unsupported selected backend stops the command
before collection. A reachable profile can still fail later if its local model
endpoint is unavailable; Weatherreporter does not switch to a remote profile.
See the [configuration reference](config.md) for field definitions and the
[troubleshooting guide](troubleshooting.md) for recovery.
See the [configuration reference](config.md) for field definitions. For a
provider failure, start with the command error and enable secure prompt debug
capture when content-rich diagnostics are required.
## Optional Prompt Debug Capture
@@ -113,9 +113,9 @@ The generated-text and render-context artifacts are written for every completed
single-report generation.
A report's metadata links the module snapshot, data package, preparation and
execution receipts, managed report, generated-text artifacts, and any available single-report
notification artifact. These current-version receipts remain transitional; use
the active command's classified error and explicit secure debug capture for
prompt diagnosis rather than relying on them as a durable interface. Batch
notification artifact. These current-version receipts are implementation
details rather than durable interfaces. Use the active command's error and
explicit secure debug capture for prompt diagnosis. Batch
notification artifacts are separate batch-level records under
`notifications/batches`.
@@ -191,7 +191,7 @@ remain available where they can be safely persisted.
- A batch notification failure preserves each report's artifacts and adds the
top-level batch notification artifact.
Use the action summary and its classified error first. For prompt or provider
Use the action summary and its error first. For prompt or provider
diagnosis, prefer an explicitly enabled secure debug capture; current-version
receipt paths may provide supplemental context when available. For a batch
failure, inspect the summary first, then inspect the affected report RunIDs or