You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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>
Copy file name to clipboardExpand all lines: docs/reference/workflows.md
+8-11Lines changed: 8 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -86,7 +86,7 @@ Lists workflows installed in the current project.
86
86
specify workflow add <source>
87
87
```
88
88
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`.
90
90
91
91
## Workflow Overlays
92
92
@@ -96,16 +96,13 @@ When `specify workflow run <workflow-id>` loads a workflow, the engine composes
96
96
97
97
### How Overlays Work
98
98
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-priorityoverlays are applied in source order (last applied wins).
100
100
101
-
Overlay files live in two locations:
101
+
Project overlay files live at:
102
102
103
-
| Location | Purpose | Tier |
104
-
| --- | --- | --- |
105
-
|`.specify/workflows/<id>/overlays/*.yml`| Shipped with the installed workflow |`installed-overlay`|
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.
208
205
209
206
#### Inspect the Composed Workflow
210
207
@@ -264,7 +261,7 @@ Higher priority (`20`) means this overlay is applied after the `add-lint` overla
264
261
265
262
### Interaction with Bundles and Updates
266
263
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>/`.
268
265
269
266
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.
0 commit comments