Repository navigation
docs: point the workflow examples at the shipped DSL and workflow_run - #39873
bolichen97 wants to merge 2 commits into
Conversation
First Principles Review (Opus 5.5) — ✅ PASSPremise-level review of First-Principles-Verdict: PASS Nothing to check. What this change shipsInventory (3 items) — 3 justifiedIntent: people copying a workflow example from the picker get run instructions that work on today's build and no "not implemented" claim. This is a FIX.
[FIRST-PRINCIPLES-REVIEWED] b1df197 Description read[DESCRIPTION-READ] 9a6125cf385ba9c6c2241e86b5c82d5ae9fa5eeefd1495b79e19229d3cd3ebf5 That sha256 names the PR description this verdict read. Recompute it with |
UX Review (Opus 5.5) — ⏭️ skippedRevision |
Design Review (Opus 5.5) — ✅ PASSDesign-level review of Design-Verdict: PASS Docstring and README text only, and the [DESIGN-REVIEWED] b1df197 Description read[DESCRIPTION-READ] 1691f383ec83fc72cca0dda42ee95bcf48aef8d5e3dbce41ffcad996da0d3ec8 That sha256 names everything this verdict read: the PR description, plus the 1 evidence file(s) the workflow collected from it and handed this review. It covers that evidence because the media strip replaces every attachment URL with the same placeholder, so an edit swapping one attachment for another would leave the description's captured text identical while what this review judged changed. Recompute it with |
GPT 6.1 Review — ✅ no blocking findingsGPT 6.1 completed its review of This comment is updated in place on each push. Review detailsNo findings. False positive or not applicable? A repository writer can comment: |
Opus 5.5 Review — ✅ no blocking findingsReviewed Verdict parsed from the review's SHA-scoped output markers for commit False positive or not applicable? A repository writer can comment: |
|
Folded into #39898 (docs sweep round 1b, module specs list A), which carries the same change to all four example files. |
Pull request was closed
Problem / Motivation
Goal: The workflow example scripts say how to run them on today's build and no longer claim the DSL is unimplemented.
The three scripts in
docs/system-specs/modules/examples/workflows/say "DSL not implemented yet", and01_review_changes.pyshowsworkflow run review-changes --args ..., a CLI command that does not exist. The folder README carried a note calling those docstrings out of date.src/kiro_crew/workflows/implements the DSL, and a run starts through theworkflow_runtool (mcp_tools/workflows.py), which takessourceandargs.Why it matters
The Workflows app serves these files in its example picker (
handle_examples), so users copy from them. A dead command and a false "not implemented" line mislead them.Not a goal
META, or behaviour..then, unwired ports and the budget counter stay; they were re-checked and still hold.What changed (motivation → approach → change)
01_review_changes.pynames theworkflow_runtool withsourceandargsas the way to run it.Backwards compatibility
Compatible: docstring and README text only; every script still validates.
Removes nothing: no file, key or function is removed.
Tests
Proof: not provable -- docs or config only
test/test_workflows_app.py -k exampleandtest/test_workflows_authoring_eval.pypass locally (they validate the shipped examples)../scripts/docs-lint.shexits 0.Manual verification
N/A — the tests above cover the example picker and validation.
Real-machine verification
N/A -- docstrings and README only; no executed line changes.
Related Issues
None.
Checklist
feat|fix|docs|style|refactor|perf|test|chore|ci|build|revert: ...); PR Hygiene does not count commitsContribution License Agreement
Contributions are accepted under the project's Apache-2.0 license.