Skip to content

Commit ed0daa7

Browse files
MarkusCopilot
andcommitted
docs(workflows): remove stale installed-overlay references from workflows.md
The 2-tier refactor (cc28185) removed the installed-overlay tier entirely, but docs/reference/workflows.md was not updated. This commit addresses all four Cluster 2 findings from the PR review: - workflow add: remove sentence about copying overlays/ subdirectory - How Overlays Work: drop installed-overlay table row and precedence prose; rewrite to 2-tier model (project overlays only, source-order tie-break) - overlay remove: drop trailing sentence about installed overlays - Interaction with Bundles: rewrite to say workflow add installs only workflow.yml; remove installed-overlay discovery language Fixes: r3596368791, r3596368831, r3596368873, r3596368919 Assisted-by: GitHub Copilot (model: claude-sonnet-4.6, autonomous) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent d51241b commit ed0daa7

1 file changed

Lines changed: 8 additions & 11 deletions

File tree

docs/reference/workflows.md

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ Lists workflows installed in the current project.
8686
specify workflow add <source>
8787
```
8888

89-
Installs a workflow from the catalog, a URL (HTTPS required), a local YAML file, or a local directory containing `workflow.yml`. Local workflow directories may include an optional `overlays/` subdirectory, which is installed alongside the workflow as shipped overlays.
89+
Installs a workflow from the catalog, a URL (HTTPS required), a local YAML file, or a local directory containing `workflow.yml`.
9090

9191
## Workflow Overlays
9292

@@ -96,16 +96,13 @@ When `specify workflow run <workflow-id>` loads a workflow, the engine composes
9696

9797
### How Overlays Work
9898

99-
An overlay is a YAML file that declares a set of edit operations against the step list of a base workflow. Overlays are applied in priority order (lowest first, highest last); at the same priority, installed overlays are applied before project overlays, so project overlays win ties.
99+
An overlay is a YAML file that declares a set of edit operations against the step list of a base workflow. Overlays are applied in priority order (lowest first, highest last); equal-priority overlays are applied in source order (last applied wins).
100100

101-
Overlay files live in two locations:
101+
Project overlay files live at:
102102

103-
| Location | Purpose | Tier |
104-
| --- | --- | --- |
105-
| `.specify/workflows/<id>/overlays/*.yml` | Shipped with the installed workflow | `installed-overlay` |
106-
| `.specify/workflows/overlays/<id>/*.yml` | Project-local customizations | `project-overlay` |
107-
108-
Project overlays always take precedence over installed overlays at the same priority.
103+
| Location | Purpose |
104+
| --- | --- |
105+
| `.specify/workflows/overlays/<id>/*.yml` | Project-local customizations |
109106

110107
### Overlay File Format
111108

@@ -204,7 +201,7 @@ specify workflow overlay enable <workflow-id> <overlay-id>
204201
specify workflow overlay remove <workflow-id> <overlay-id>
205202
```
206203

207-
Removes the project overlay file. Installed overlays shipped with a workflow are removed by `specify workflow remove <workflow-id>`, which deletes the entire workflow directory.
204+
Removes the project overlay file.
208205

209206
#### Inspect the Composed Workflow
210207

@@ -264,7 +261,7 @@ Higher priority (`20`) means this overlay is applied after the `add-lint` overla
264261

265262
### Interaction with Bundles and Updates
266263

267-
`specify workflow add <local-directory>` copies `workflow.yml` and an optional `overlays/` subdirectory into `.specify/workflows/<id>/`. Overlays shipped this way are discovered automatically as `installed-overlay` layers.
264+
`specify workflow add <local-directory>` installs `workflow.yml` from the local directory into `.specify/workflows/<id>/`.
268265

269266
When an installed workflow is refreshed or reinstalled, project overlays in `.specify/workflows/overlays/<id>/` are preserved because they live outside the installed workflow directory.
270267

0 commit comments

Comments
 (0)