Skip to content

Commit 980f9c1

Browse files
mnriemCopilot
andauthored
docs: consolidate and correct workflow documentation (#5225)
* docs: consolidate and correct workflow documentation Move workflow documentation into nine canonical docs/workflows pages, update navigation and inbound links, and preserve documentation regression assertions. Remove superseded pages without forwarding stubs; runtime behavior is unchanged. Assisted-by: GitHub Copilot App (model: GPT-6.1 Sol, autonomous) Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> * docs: correct workflow catalog merge and failure guidance Describe full-catalog merging for exact lookups, fetch fallback, malformed entry handling, and winning-source trust boundaries. Add a documentation regression guard without changing runtime behavior. Assisted-by: GitHub Copilot App (model: GPT-6.1 Sol, autonomous) Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
1 parent f22ae68 commit 980f9c1

32 files changed

Lines changed: 2601 additions & 2774 deletions

‎README.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -49,9 +49,9 @@ Spec Kit combines ready-to-use processes with composable mechanisms:
4949
| Adapt templates, commands, terminology, or methodology | [Preset](https://github.github.io/spec-kit/presets/overview.html) |
5050
| Enforce organizational or regulatory standards | [Preset](https://github.github.io/spec-kit/presets/overview.html) |
5151
| Override a template for one project | [Project-local override](https://github.github.io/spec-kit/guides/customization.html#project-local-overrides-and-resolution) |
52-
| Automate prompts, commands, gates, and shell tasks | [Workflow](https://github.github.io/spec-kit/reference/workflows.html) |
53-
| Modify an installed workflow without forking it | [Workflow overlay](https://github.github.io/spec-kit/reference/workflows.html#workflow-overlays) |
54-
| Add reusable executable behavior to workflows | [Workflow step](https://github.github.io/spec-kit/reference/workflows.html#custom-step-packages) |
52+
| Automate prompts, commands, gates, and shell tasks | [Workflow](https://github.github.io/spec-kit/workflows/overview.html) |
53+
| Modify an installed workflow without forking it | [Workflow overlay](https://github.github.io/spec-kit/workflows/overlays.html) |
54+
| Add reusable executable behavior to workflows | [Workflow step](https://github.github.io/spec-kit/workflows/developing.html#custom-step-packages) |
5555
| Install a curated setup for a role or team | [Bundle](https://github.github.io/spec-kit/reference/bundles.html) |
5656
| Discover community components | [Catalog](https://github.github.io/spec-kit/reference/catalogs.html) |
5757
| Host a private catalog of approved components | [Catalog](https://github.github.io/spec-kit/reference/catalogs.html) |

‎design/workflow-step.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ A workflow step type defines what a `type:` in workflow YAML does. This is an
44
extension point of the workflow engine, distinct from an agent integration:
55
integrations dispatch work to an agent; steps validate and execute workflow
66
behavior. For the overall engine, see
7-
[Workflow System Architecture](../workflows/ARCHITECTURE.md); for YAML usage,
8-
see [Workflows](../docs/reference/workflows.md).
7+
[Workflow API and execution model](https://github.github.io/spec-kit/workflows/api.html); for YAML usage,
8+
see [Workflows](https://github.github.io/spec-kit/workflows/overview.html).
99

1010
## Delivery and registration
1111

@@ -92,6 +92,6 @@ thread-safe, with per-run data in `config` and `context`, not on `self`.
9292
resume or nested/concurrent execution when relevant. Registry and engine
9393
coverage lives in `tests/test_workflows.py`; focused step suites may live
9494
under `tests/workflows/`.
95-
3. Update the [workflow reference](../docs/reference/workflows.md) when a
95+
3. Update the [workflow step reference](https://github.github.io/spec-kit/workflows/steps.html) when a
9696
built-in step changes the YAML users can write. Keep agent-specific CLI
9797
dispatch in integrations rather than duplicating it in step types.

‎docs/README.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,15 @@ To build the documentation locally:
4545
- `presets/api.md` - Manifest, composition, and lifecycle reference
4646
- `presets/catalogs.md` - Preset catalog configuration, schemas, and trust
4747
- `presets/publishing.md` - Preset publishing and catalog submission guide
48+
- `workflows/overview.md` - Workflow user guide and run/review/resume walkthrough
49+
- `workflows/cli.md` - Workflow, overlay, step, and catalog CLI reference
50+
- `workflows/developing.md` - Workflow and custom-step authoring guide
51+
- `workflows/api.md` - YAML, step API, execution, and persisted-state contracts
52+
- `workflows/steps.md` - Built-in step configuration and outputs
53+
- `workflows/expressions.md` - Expression language, runtime context, and shell safety
54+
- `workflows/overlays.md` - Workflow composition through overlays and slots
55+
- `workflows/catalogs.md` - Workflow and step catalogs, releases, and trust
56+
- `workflows/publishing.md` - Workflow publishing and catalog submission guide
4857
- `community/extensions.md` - Community extension listing
4958
- `integrations/index.md` - Integration directory and shared setup guidance
5059
- `integrations/cli.md` - Shared integration management CLI reference

‎docs/community/workflow-steps.md‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -87,8 +87,9 @@ The package must satisfy the current installer and loader contract:
8787
- `.git`, `__pycache__`, and `.DS_Store` are excluded from installation;
8888
submission automation rejects case-insensitive aliases of these components.
8989

90-
See [Custom step packages](../reference/workflows.md#custom-step-packages) for
91-
the complete install, validation, and runtime behavior.
90+
See [Custom step packages](../workflows/developing.md#custom-step-packages) for
91+
package validation and runtime behavior, and the
92+
[step installation reference](../workflows/cli.md#step-management) for installation.
9293

9394
## Submission Contract
9495

‎docs/docfx.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@
1111
"guides/*.md",
1212
"integrations/*.md",
1313
"presets/*.md",
14+
"workflows/*.md",
1415
"reference/*.md",
1516
"install/*.md"
1617
]

‎docs/guides/customization.md‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,9 @@ agents and setup, or [contributing integrations](../integrations/contributing.md
2626
to develop an adapter.
2727

2828
Workflow step packages extend the step types available to workflows. See
29-
[custom step packages](../reference/workflows.md#custom-step-packages) for
30-
installation and execution, and
29+
[custom step packages](../workflows/developing.md#custom-step-packages) for
30+
authoring and execution, the [step CLI](../workflows/cli.md#step-management)
31+
for installation, and
3132
[community workflow steps](../community/workflow-steps.md) for discovery and
3233
contribution guidance. Review executable packages before installing or using them.
3334

@@ -117,4 +118,4 @@ for product manager, business analyst, security researcher, and developer setups
117118
Community components are independently maintained. Review source code before
118119
installation and use it at your own discretion. Visit the
119120
[community guide](../community/overview.md) to discover components or publish your
120-
own, and the [workflow reference](../reference/workflows.md) to automate a process.
121+
own, and the [workflow guide](../workflows/overview.md) to automate a process.

‎docs/index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ Including entirely different processes:
7878

7979
<a href="presets/overview.md" class="pillar-link">Presets →</a>&nbsp;&nbsp;
8080
<a href="extensions/overview.md" class="pillar-link">Extensions →</a>&nbsp;&nbsp;
81-
<a href="reference/workflows.md" class="pillar-link">Workflows →</a>&nbsp;&nbsp;
81+
<a href="workflows/overview.md" class="pillar-link">Workflows →</a>&nbsp;&nbsp;
8282
<a href="reference/bundles.md" class="pillar-link">Bundles →</a>
8383

8484
</div>

‎docs/integrations/cli.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -480,7 +480,7 @@ parsed using POSIX shell quoting. Placement and duplicate-flag behavior differ
480480
by adapter; see the agent guide, especially for Docker Agent and Goose.
481481

482482
Setup `--integration-options` are separate from workflow
483-
[`integration_args` and `integration_options`](../reference/workflows.md#per-step-integration-configuration).
483+
[`integration_args` and `integration_options`](../workflows/steps.md#per-step-integration-configuration).
484484
Adapters reject non-empty per-step configuration unless they implement it;
485485
Docker Agent currently exposes structured agent/safety configuration.
486486
Headless approval flags, model forwarding, and structured-output support are

‎docs/integrations/docker-agent.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,4 +62,4 @@ variable remains supported when no per-step reference is supplied. A per-step
6262
reference overrides the entire legacy value, including any flags it contains.
6363
Dispatch uses `run --exec`, adds requested `--json` and `--model` flags, and
6464
places the prompt after `--` so prompt text cannot become CLI options.
65-
See [per-step integration configuration](../reference/workflows.md#per-step-integration-configuration).
65+
See [per-step integration configuration](../workflows/steps.md#per-step-integration-configuration).

‎docs/reference/bundles.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -338,7 +338,7 @@ non-default source.
338338
For workflow components, inspect shell `run` and `env` fields and their
339339
referenced code, including changes introduced by active overlays. This applies
340340
even to `strict: true` steps: environment bindings can change executable lookup
341-
or runtime loading. See [Reviewing shell execution](workflows.md#reviewing-shell-execution).
341+
or runtime loading. See [Reviewing shell execution](../workflows/steps.md#reviewing-shell-execution).
342342

343343
### List the Catalog Stack
344344

0 commit comments

Comments
 (0)