docs: teach draft explain codes
This commit is contained in:
@@ -80,10 +80,10 @@ clear operator feedback before adding more architecture.
|
|||||||
capabilities without mutating or saving the draft workspace.
|
capabilities without mutating or saving the draft workspace.
|
||||||
- Completed: draft validation now preserves structured core validation issues
|
- Completed: draft validation now preserves structured core validation issues
|
||||||
and adds exact `wf draft bind` repair hints for missing state fields.
|
and adds exact `wf draft bind` repair hints for missing state fields.
|
||||||
- Planned: expand `wf explain` to cover draft/workflow validation codes such as
|
- Completed: `wf explain` now covers draft/workflow validation codes such as
|
||||||
`unknown_edge_destination`, `invalid_source_path`, and `patch_invalid`.
|
`unknown_edge_destination`, `invalid_source_path`, and `patch_invalid`.
|
||||||
Implementation plan:
|
Implementation plan:
|
||||||
[`draft explain diagnostics`](superpowers/plans/2026-06-28-explain-draft-diagnostics.md).
|
[`draft explain diagnostics`](historical/superpowers/plans/2026-06-28-explain-draft-diagnostics.md).
|
||||||
- Planned: let draft workspaces persist invalid intermediate route states so
|
- Planned: let draft workspaces persist invalid intermediate route states so
|
||||||
agents can add forward-routed target steps before final validation/save.
|
agents can add forward-routed target steps before final validation/save.
|
||||||
Implementation plan:
|
Implementation plan:
|
||||||
|
|||||||
@@ -556,6 +556,15 @@ wf explain --list --format compact
|
|||||||
`wf explain` is exact-match and docs-backed. It is not fuzzy search and does not
|
`wf explain` is exact-match and docs-backed. It is not fuzzy search and does not
|
||||||
generate prose.
|
generate prose.
|
||||||
|
|
||||||
|
Draft authoring diagnostics commonly include:
|
||||||
|
|
||||||
|
- `invalid_source_path`
|
||||||
|
- `invalid_destination_path`
|
||||||
|
- `unknown_edge_destination`
|
||||||
|
- `unknown_outcome`
|
||||||
|
- `patch_invalid`
|
||||||
|
- `revision_conflict`
|
||||||
|
|
||||||
## Common Diagnostics
|
## Common Diagnostics
|
||||||
|
|
||||||
### Local/dev auth records
|
### Local/dev auth records
|
||||||
|
|||||||
@@ -108,6 +108,9 @@ top-level `compiled_plan` key from the CLI output.
|
|||||||
- Do not request unbounded traces.
|
- Do not request unbounded traces.
|
||||||
- Do not treat wrapper hints as semantic guarantees.
|
- Do not treat wrapper hints as semantic guarantees.
|
||||||
- If validation fails, run `wf explain <code>` or `wf explain --input-file <validation-output.json>`.
|
- If validation fails, run `wf explain <code>` or `wf explain --input-file <validation-output.json>`.
|
||||||
|
- For draft validation errors, run `wf explain <code>`. If routes point to a
|
||||||
|
missing step, create the target step first or repair routes with
|
||||||
|
`wf draft handle` / `wf draft branch`.
|
||||||
- Do not use planning-session specs or implementation plans as user-facing runtime guidance.
|
- Do not use planning-session specs or implementation plans as user-facing runtime guidance.
|
||||||
- Do not confuse draft shape with raw plan shape: drafts use `steps/routes/use`;
|
- Do not confuse draft shape with raw plan shape: drafts use `steps/routes/use`;
|
||||||
raw plans use `nodes/edges/node`.
|
raw plans use `nodes/edges/node`.
|
||||||
|
|||||||
@@ -29,6 +29,9 @@ Common diagnostics:
|
|||||||
Use `wf explain <diagnostic-code>` after validation failures to get
|
Use `wf explain <diagnostic-code>` after validation failures to get
|
||||||
human-readable explanations.
|
human-readable explanations.
|
||||||
|
|
||||||
|
`unknown_edge_destination`: a route points to a missing step. Add the target
|
||||||
|
step or repair the route; do not guess `draft step add` or `draft export`.
|
||||||
|
|
||||||
## Run Debugging
|
## Run Debugging
|
||||||
|
|
||||||
If a run fails:
|
If a run fails:
|
||||||
|
|||||||
Reference in New Issue
Block a user