Skip to content

docs: rewrite quick-fixes how-to around Quick Dev#2065

Merged
alexeyv merged 2 commits intomainfrom
fix-quick-fixes-doc
Mar 19, 2026
Merged

docs: rewrite quick-fixes how-to around Quick Dev#2065
alexeyv merged 2 commits intomainfrom
fix-quick-fixes-doc

Conversation

@alexeyv
Copy link
Copy Markdown
Collaborator

@alexeyv alexeyv commented Mar 19, 2026

Summary

  • Rewrites the quick-fixes how-to to use Quick Dev as the single entry point, removing all DEV agent references
  • Shows free-form intent examples (inline, discuss-first, invoke-first, file, issue URL)
  • Adds deferred work section explaining how Quick Dev keeps scope tight
  • Fixes stale "reduces Quick Flow ceremony" opening in the quick-dev explainer
  • Updates both EN and zh-cn versions

Test plan

  • Verify quick-fixes page renders correctly on dev server
  • Verify quick-dev explainer opening reads cleanly
  • Confirm all internal links resolve (quick-flow.md → quick-dev.md)

🤖 Generated with Claude Code

alexeyv and others added 2 commits March 19, 2026 00:05
Remove DEV agent references and simplify to Quick Dev as the single
entry point. Show free-form intent examples, add deferred work section,
clarify that Quick Dev commits for you.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@alexeyv alexeyv merged commit 4cb58ba into main Mar 19, 2026
7 checks passed
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 19, 2026

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 79a130ab-2a02-47fd-a27f-9d408d3d2f8f

📥 Commits

Reviewing files that changed from the base of the PR and between 3bb953f and 871d921.

📒 Files selected for processing (4)
  • docs/explanation/quick-dev.md
  • docs/how-to/quick-fixes.md
  • docs/zh-cn/explanation/quick-dev.md
  • docs/zh-cn/how-to/quick-fixes.md

📝 Walkthrough

Walkthrough

This pull request updates documentation in both English and Chinese to redirect workflow guidance from the DEV agent to Quick Dev for quick fixes. Changes include removing decision tables, restructuring workflow steps, adding a deferred work section, and updating related terminology.

Changes

Cohort / File(s) Summary
Quick Dev Explanation
docs/explanation/quick-dev.md, docs/zh-cn/explanation/quick-dev.md
Rephrased opening description to remove specific product label and tighten wording around human-in-the-loop behavior emphasis.
Quick Fixes How-To Guidance
docs/how-to/quick-fixes.md, docs/zh-cn/how-to/quick-fixes.md
Replaced DEV agent guidance with Quick Dev instructions, removed "Choose Your Approach" decision table, restructured workflow steps (fresh chat, free-form intent, approval loop, review and push), replaced "What you get" section, added "Deferred Work" section, and updated upgrade criteria and terminology references.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

Suggested reviewers

  • bmadcode
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix-quick-fixes-doc
📝 Coding Plan
  • Generate coding plan for human review comments

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@alexeyv alexeyv deleted the fix-quick-fixes-doc branch March 19, 2026 06:16
@augmentcode
Copy link
Copy Markdown

augmentcode bot commented Mar 19, 2026

🤖 Augment PR Summary

Summary: This PR refreshes the “Quick Fixes” documentation to position Quick Dev as the primary workflow for small, targeted changes, and updates the Quick Dev explainer opening for clearer messaging.

Changes:

  • Rewrites the Quick Fixes how-to to use Quick Dev as the single entry point (removing DEV agent / Quick Flow Solo Dev routing).
  • Adds multiple free-form intent examples (inline intent, discuss-first, invoke-first, file-path intent, issue URL).
  • Updates the workflow steps to emphasize fresh chats, clarifications/approval, review, and pushing after completion.
  • Adds a “Deferred Work” section describing how Quick Dev records out-of-scope or unrelated findings to deferred-work.md.
  • Adjusts “When to upgrade” guidance to point readers toward the full BMad Method for broader or discovery-heavy work.
  • Updates both English and zh-cn versions for consistency.
  • Fixes stale opening language in the Quick Dev explainer (“reduces Quick Flow ceremony”) to a clearer, tool-agnostic framing.

Technical Notes: The updated how-to assumes Quick Dev can capture intent from plain text, file paths, and issue links, and emphasizes keeping each run to a single goal with deferred backlog capture.

🤖 Was this summary useful? React with 👍 or 👎

Copy link
Copy Markdown

@augmentcode augmentcode bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review completed. 2 suggestions posted.

Fix All in Augment

Comment augment review to trigger a new review at any time.


```text
bmad-dev
run quick-dev — Fix the login validation bug that allows empty passwords.
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The docs elsewhere describe invoking the workflow by its skill name (e.g. bmad-quick-dev), so the run quick-dev — ... examples may not be discoverable/valid in many IDE setups. Consider explicitly naming the canonical skill command here (or mentioning both forms) to avoid users getting stuck at step 2.

Severity: medium

Fix This in Augment

🤖 Was this useful? React with 👍 or 👎, or 🚀 if it prevented an incident/outage.


```text
/bmad-agent-bmm-dev
run quick-dev — 修复允许空密码的登录验证 bug。
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

其他文档里工作流一般按技能名调用(例如 bmad-quick-dev),所以这里的 run quick-dev — ... 可能在不少 IDE 配置里不可用/不易发现。建议在此处明确给出规范的技能命令(或同时说明两种写法)以避免读者卡在第 2 步。

Severity: medium

Fix This in Augment

🤖 Was this useful? React with 👍 or 👎, or 🚀 if it prevented an incident/outage.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant