docs(workflows): add the built-in 'init' step type to the Step Types table#3234
Merged
Merged
Conversation
…table The Step Types table in docs/reference/workflows.md listed command, prompt, shell, gate, if, switch, while, do-while, fan-out, and fan-in, but omitted 'init' -- which IS a registered built-in (workflows/__init__.py _register_builtin_steps registers InitStep) and is documented in steps/init/__init__.py as bootstrapping a project (equivalent to 'specify init'). Add the missing row so the reference matches the registry. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the workflow reference documentation to include the built-in init step type, bringing the “Step Types” table in line with the actual set of registered built-in steps in the workflow engine.
Changes:
- Add an
initrow to the Step Types table indocs/reference/workflows.md.
Show a summary per file
| File | Description |
|---|---|
| docs/reference/workflows.md | Adds init to the documented list of workflow step types. |
Review details
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 1/1 changed files
- Comments generated: 0
- Review effort level: Low
Collaborator
|
Thank you! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
The Step Types table in
docs/reference/workflows.mdlistscommand,prompt,shell,gate,if,switch,while,do-while,fan-out, andfan-in— but omitsinit, which is a registered built-in step.initis registered inworkflows/__init__.py(_register_builtin_steps→_register_step(InitStep())) and documented insteps/init/__init__.pyas bootstrapping a project (equivalent tospecify init) from within a workflow. So the reference table was missing a real, usable step type.Fix
Add the
initrow to the table. Docs-only.Testing
markdownlint-cli2 docs/reference/workflows.md→ 0 errors._register_builtin_steps): withinitadded, all ten registered built-ins are now documented.AI Disclosure
Found and fixed with Claude Code (Claude Opus 4.8) under my direction. AI cross-referenced the documented Step Types table against the runtime step registry and found
initmissing; I confirmedInitStepis registered and its documented purpose, and reviewed the diff before submitting.