refactor(quick-dev): rename tech-spec prefix to spec#2109
Conversation
450b2d9 to
110d24e
Compare
🤖 Augment PR SummarySummary: This PR renames the Quick Dev “tech-spec” artifact prefix to “spec” and propagates the change across workflows and documentation. Changes:
Technical Notes: The new glob is intended to match both 🤖 Was this summary useful? React with 👍 or 👎 |
| | Architecture | `{planning_artifacts}/*architecture*.md` (whole) or `{planning_artifacts}/*architecture*/*.md` (sharded) | FULL_LOAD | | ||
| | UX Design | `{planning_artifacts}/*ux*.md` (whole) or `{planning_artifacts}/*ux*/*.md` (sharded) | FULL_LOAD | | ||
| | Tech Spec | `{planning_artifacts}/*tech-spec*.md` (whole) | FULL_LOAD | | ||
| | Spec | `{planning_artifacts}/*spec-*.md` (whole) | FULL_LOAD | |
There was a problem hiding this comment.
The {planning_artifacts}/*spec-*.md pattern won’t match legacy whole-doc names like tech-spec.md/spec.md (no trailing -), so Correct Course may silently miss the spec in some projects. (Guideline: skill_validation)
Severity: medium
🤖 Was this useful? React with 👍 or 👎, or 🚀 if it prevented an incident/outage.
src/bmm-skills/4-implementation/bmad-quick-dev/step-01-clarify-and-route.md
Outdated
Show resolved
Hide resolved
📝 WalkthroughWalkthroughThe PR systematically updates documentation and workflow configuration files to replace "tech-spec" terminology with "spec" across English, French, and Chinese documentation, and adjusts corresponding file naming conventions and path patterns in workflow implementation files. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 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. Important Merge conflicts detected (Beta)
✨ 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 |
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/tutorials/getting-started.md (1)
72-83:⚠️ Potential issue | 🟡 MinorComplete the terminology rename in the planning-track table
This section now uses
spec(Line 72), but the Quick Flow row still says “Tech-spec only”. Please rename it to keep terminology consistent.Suggested doc fix
-| **Quick Flow** | Bug fixes, simple features, clear scope (1-15 stories) | Tech-spec only | +| **Quick Flow** | Bug fixes, simple features, clear scope (1-15 stories) | Spec only |🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/tutorials/getting-started.md` around lines 72 - 83, The planning-track table in docs/tutorials/getting-started.md is inconsistent: change the "Quick Flow" table cell that currently reads "Tech-spec only" to match the rest of the doc and use "spec only" (or "Spec only" per local capitalization) so the Quick Flow row aligns with the earlier use of "spec"; update the "Quick Flow" row in the planning-track table accordingly.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/fr/reference/workflow-map.md`:
- Line 71: Update the workflow-map entry for the `bmad-quick-dev` workflow to
reflect the actual generated filename pattern: change the documented `spec.md`
output to `spec-{slug}.md` (and keep the "+ code" note intact) so the table
accurately shows the produced files.
---
Outside diff comments:
In `@docs/tutorials/getting-started.md`:
- Around line 72-83: The planning-track table in
docs/tutorials/getting-started.md is inconsistent: change the "Quick Flow" table
cell that currently reads "Tech-spec only" to match the rest of the doc and use
"spec only" (or "Spec only" per local capitalization) so the Quick Flow row
aligns with the earlier use of "spec"; update the "Quick Flow" row in the
planning-track table accordingly.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: a6cccabc-3675-408a-be41-51f7968ae4c2
⛔ Files ignored due to path filters (1)
src/bmm-skills/module-help.csvis excluded by!**/*.csv
📒 Files selected for processing (15)
docs/_STYLE_GUIDE.mddocs/explanation/established-projects-faq.mddocs/explanation/project-context.mddocs/fr/reference/workflow-map.mddocs/fr/tutorials/getting-started.mddocs/reference/workflow-map.mddocs/tutorials/getting-started.mddocs/zh-cn/_STYLE_GUIDE.mddocs/zh-cn/explanation/established-projects-faq.mddocs/zh-cn/reference/workflow-map.mdsrc/bmm-skills/4-implementation/bmad-correct-course/workflow.mdsrc/bmm-skills/4-implementation/bmad-quick-dev/spec-template.mdsrc/bmm-skills/4-implementation/bmad-quick-dev/step-01-clarify-and-route.mdsrc/bmm-skills/4-implementation/bmad-quick-dev/step-02-plan.mdsrc/bmm-skills/4-implementation/bmad-quick-dev/workflow.md
110d24e to
fd72706
Compare
Summary
tech-spec-template.md→spec-template.mdand update all filename-generating references (tech-spec-wip→spec-wip,tech-spec-{slug}→spec-{slug})*tech-spec*to*spec-*to match both old and new naming without catchingux-design-specification.mdTest plan
spec-{slug}.mdspec-wip.md*spec-*glob matches bothtech-spec-foo.mdandspec-bar.md*spec-*glob does NOT matchux-design-specification.mdnpm run qualitypasses🤖 Generated with Claude Code