refactor: rename create-tech-spec to quick-spec for QuickFlow branding#1290
Conversation
📝 WalkthroughWalkthroughThis PR systematically renames the "create-tech-spec" workflow and command to "quick-spec" across agent configurations, workflow definitions, and documentation files spanning multiple modules. The changes update workflow paths, IDs, references, and command invocations while preserving functionality. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~18 minutes Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
docs/how-to/workflows/quick-spec.md (1)
1-7: Inconsistent workflow name in opening description.Line 7 still references the old
tech-specworkflow name, contradicting the refactored title and description. The documentation should consistently usequick-specthroughout.Use the `quick-spec` workflow for Quick Flow projects to go directly from idea to implementation-ready specification.
🤖 Fix all issues with AI agents
In @src/modules/bmgd/workflows/bmgd-quick-flow/quick-spec/workflow.yaml:
- Around line 1-2: The top-line comment is inconsistent with the workflow name;
update the title comment to reflect the renamed workflow by changing the comment
from "Create Tech-Spec" to "Quick-Spec" so it matches the workflow identifier
(name: quick-spec) and keeps file self-documentation accurate.
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (21)
docs/explanation/agents/barry-quick-flow.mddocs/explanation/core-concepts/agent-roles.mddocs/explanation/features/quick-flow.mddocs/explanation/game-dev/agents.mddocs/how-to/get-answers-about-bmad.mddocs/how-to/workflows/bmgd-quick-flow.mddocs/how-to/workflows/quick-spec.mddocs/reference/agents/index.mdsrc/modules/bmgd/agents/game-solo-dev.agent.yamlsrc/modules/bmgd/workflows/bmgd-quick-flow/quick-spec/instructions.mdsrc/modules/bmgd/workflows/bmgd-quick-flow/quick-spec/workflow.yamlsrc/modules/bmgd/workflows/workflow-status/paths/quickflow-brownfield.yamlsrc/modules/bmm/agents/quick-flow-solo-dev.agent.yamlsrc/modules/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-01-mode-detection.mdsrc/modules/bmm/workflows/bmad-quick-flow/quick-dev/workflow.mdsrc/modules/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-01-understand.mdsrc/modules/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-02-investigate.mdsrc/modules/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-03-generate.mdsrc/modules/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-04-review.mdsrc/modules/bmm/workflows/bmad-quick-flow/quick-spec/tech-spec-template.mdsrc/modules/bmm/workflows/bmad-quick-flow/quick-spec/workflow.md
🧰 Additional context used
📓 Path-based instructions (1)
**/*
⚙️ CodeRabbit configuration file
**/*: Focus on inconsistencies, contradictions, edge cases and serious issues.
Avoid commenting on minor issues such as linting, formatting and style issues.
When providing code suggestions, use GitHub's suggestion format:<code changes>
Files:
docs/how-to/workflows/bmgd-quick-flow.mddocs/explanation/agents/barry-quick-flow.mdsrc/modules/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-04-review.mddocs/how-to/workflows/quick-spec.mdsrc/modules/bmgd/agents/game-solo-dev.agent.yamldocs/explanation/features/quick-flow.mdsrc/modules/bmgd/workflows/bmgd-quick-flow/quick-spec/workflow.yamlsrc/modules/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-01-mode-detection.mddocs/how-to/get-answers-about-bmad.mdsrc/modules/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-02-investigate.mdsrc/modules/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-01-understand.mdsrc/modules/bmm/workflows/bmad-quick-flow/quick-dev/workflow.mddocs/reference/agents/index.mdsrc/modules/bmm/agents/quick-flow-solo-dev.agent.yamldocs/explanation/core-concepts/agent-roles.mdsrc/modules/bmm/workflows/bmad-quick-flow/quick-spec/workflow.mdsrc/modules/bmgd/workflows/workflow-status/paths/quickflow-brownfield.yamldocs/explanation/game-dev/agents.mdsrc/modules/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-03-generate.md
🔇 Additional comments (19)
docs/explanation/features/quick-flow.md (1)
165-169: ✓ Related links properly updated for quick-spec rename.The reference link correctly points to the renamed documentation path and uses the new branding terminology. Link format is consistent with other references in the "Related" section (absolute paths with
/docs/prefix).docs/reference/agents/index.md (1)
73-81: ✓ Quick Flow Solo Dev commands correctly renamed.The command reference is properly updated from
*create-tech-specto*quick-spec, and the description accurately reflects the workflow's purpose. Change is consistent with other agent command listings and maintains parallel structure with the*quick-devworkflow.docs/how-to/get-answers-about-bmad.md (1)
10-14: ✓ Example correctly demonstrates renamed Quick Flow command.The Quick Flow guidance now accurately shows
quick-specfollowed byquick-dev, aligning with the new QuickFlow branding. The example is clear and correctly demonstrates the two-step workflow.src/modules/bmgd/workflows/workflow-status/paths/quickflow-brownfield.yaml (1)
14-19: The rename fromcreate-tech-spectoquick-specis complete across all active configuration files.Code verification confirms no lingering references in workflows, agents, or documentation. The only remaining references to
create-tech-specappear in CHANGELOG.md as historical documentation, which is appropriate. Both key agent files (game-solo-dev.agent.yamlandquick-flow-solo-dev.agent.yaml) are properly updated with correctquick-specworkflow paths.However, per the PR objectives, the manual end-to-end test of running
/quick-specin a fresh context is still pending. Please complete this verification before merging to ensure the command works as expected.docs/how-to/workflows/quick-spec.md (1)
157-157: Clarify "Quick Spec Flow" phrasing in related links.The related link text says "Understanding Quick Spec Flow," but based on the refactoring context, this should likely reference "Quick Flow" (the higher-level concept that includes both Quick Spec and Quick Dev). Verify the intended meaning.
src/modules/bmm/workflows/bmad-quick-flow/quick-dev/workflow.md (1)
43-43: Verify workflow file format change (YAML → Markdown).Line 43 shows the quick-spec workflow path changed from
.yamlto.mdformat:
- Old:
create-tech-spec/workflow.yaml- New:
quick-spec/workflow.mdThis is a structural change beyond the rename refactoring. Confirm that:
- The quick-spec workflow was actually converted to Markdown format
- The workflow execution engine can properly load and interpret Markdown-based workflows (vs. the previous YAML format)
- This change is documented or intentional
src/modules/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-01-mode-detection.md (1)
98-127: Variable renaming is consistent and complete.All three occurrences of the workflow variable in the escalation handling sections (lines 98, 111, 126) are correctly updated from
{create_tech_spec_workflow}to{quick_spec_workflow}, maintaining consistency with the workflow.md definitions.docs/explanation/agents/barry-quick-flow.md (3)
40-43: Menu item and workflow path correctly updated.The renaming of the menu command from
create-tech-spectoquick-spec(line 40) and the corresponding workflow path update (line 42) are consistent with the PR objectives. The path correctly references the new directory structure.
92-92: Diagram and command references consistently updated.The Mermaid flowchart (line 92), section heading (line 110), and command example (line 240) all correctly reflect the
quick-specnomenclature. No lingering references tocreate-tech-specdetected.Also applies to: 110-110, 240-240
313-317: All cross-referenced documentation paths are valid and exist.The "Related Documentation" section references are intact:
/docs/explanation/core-concepts/agent-roles.md✓/docs/explanation/architecture/four-phases.md✓/docs/how-to/workflows/run-sprint-planning.md✓/docs/tutorials/getting-started/getting-started-bmadv6.md✓/docs/explanation/features/party-mode.md✓src/modules/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-04-review.md (2)
112-112: Workflow invocation commands correctly reference updated naming.Both command invocations (
quick-dev {finalFile}) at lines 112 and 155 correctly use the new workflow command name and are consistent with the overall Quick Flow renaming.Also applies to: 155-155
5-5: Workflow path correctly updated to reflect quick-spec directory.The
workflow_pathfrontmatter variable on line 5 has been updated to reference thequick-specdirectory structure, and the downstream template variables ({wipFile},{implementation_artifacts}) that depend on this path are properly configured to resolve correctly.src/modules/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-02-investigate.md (1)
5-6: Workflow path and next step file reference correctly updated.The
workflow_pathat line 5 is updated toquick-spec, and thenextStepFileat line 6 correctly derives from this updated path to referencestep-03-generate.md. All four workflow steps maintain consistentworkflow_pathvalues, and thenextStepFilereferences form a proper sequence from step-01 through step-03.src/modules/bmgd/workflows/bmgd-quick-flow/quick-spec/workflow.yaml (1)
17-17: LGTM!The installed_path correctly references the new quick-spec directory structure.
src/modules/bmm/workflows/bmad-quick-flow/quick-spec/workflow.md (2)
2-2: LGTM!The workflow name is correctly updated to "quick-spec" in the front matter, matching the renamed workflow directory and aligning with the QuickFlow branding objective.
13-13: LGTM!The heading correctly reflects the new "Quick-Spec Workflow" naming, maintaining consistency with the front-matter and overall rename.
src/modules/bmgd/agents/game-solo-dev.agent.yaml (1)
38-40: Verify the trigger fuzzy match aligns with the renamed workflow.The workflow path has been updated to "quick-spec", but the fuzzy match trigger remains "tech-spec". This creates a mismatch between the workflow name and its trigger pattern. Users following the new QuickSpec branding might type "quick-spec" and not match this trigger via fuzzy matching.
Consider updating the trigger to align with the new naming:
Suggested alignment
- trigger: TS or fuzzy match on quick-spec workflow: "{project-root}/_bmad/bmgd/workflows/bmgd-quick-flow/quick-spec/workflow.yaml" description: "[TS] Architect a technical spec with implementation-ready stories"Alternatively, if backward compatibility during transition is desired, verify whether the fuzzy matching should support both "tech-spec" and "quick-spec" patterns.
src/modules/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-03-generate.md (1)
5-7: LGTM!The workflow_path correctly updated to reference the renamed "quick-spec" directory, and dependent paths (nextStepFile, wipFile) properly derive from it.
src/modules/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-01-understand.md (1)
5-9: LGTM!The workflow_path is correctly updated to "quick-spec", and all dependent file references (nextStepFile, skipToStepFile, templateFile, wipFile) properly derive from it, maintaining the correct path resolution.
| # Quick-Flow: Create Tech-Spec (Game Development) | ||
| name: create-tech-spec | ||
| name: quick-spec |
There was a problem hiding this comment.
Update the title comment to match the renamed workflow.
The title comment still references "Create Tech-Spec" while the workflow has been renamed to "quick-spec". This creates inconsistency in the file's self-documentation.
Proposed fix
| # Quick-Flow: Create Tech-Spec (Game Development) | |
| name: create-tech-spec | |
| name: quick-spec | |
| # Quick-Flow: Quick-Spec (Game Development) | |
| name: quick-spec |
🤖 Prompt for AI Agents
In @src/modules/bmgd/workflows/bmgd-quick-flow/quick-spec/workflow.yaml around
lines 1 - 2, The top-line comment is inconsistent with the workflow name; update
the title comment to reflect the renamed workflow by changing the comment from
"Create Tech-Spec" to "Quick-Spec" so it matches the workflow identifier (name:
quick-spec) and keeps file self-documentation accurate.
2 participants
Summary
create-tech-specworkflow toquick-specacross BMM and BMGD modulesChanges
BMM Module:
bmad-quick-flow/create-tech-spec/→quick-spec/create_tech_spec_workflow→quick_spec_workflowBMGD Module:
bmgd-quick-flow/create-tech-spec/→quick-spec/Documentation:
docs/how-to/workflows/create-tech-spec.md→quick-spec.mdTest plan
npm run test:schemas- All 52 tests passnpm run test:install- All 13 tests passnpm run validate:schemas- All 24 agents validcreate-tech-speccommand references in src/ and docs//quick-specin fresh contextBreaking Change
This renames a user-facing command. Existing users with scripts or bookmarks targeting
create-tech-specwill need to update toquick-spec.