Skip to content

docs: rewrite get-answers-about-bmad for flow and accuracy#2213

Merged
alexeyv merged 1 commit intomainfrom
docs/rewrite-get-answers
Apr 5, 2026
Merged

docs: rewrite get-answers-about-bmad for flow and accuracy#2213
alexeyv merged 1 commit intomainfrom
docs/rewrite-get-answers

Conversation

@alexeyv
Copy link
Copy Markdown
Collaborator

@alexeyv alexeyv commented Apr 5, 2026

Summary

  • Restructure from two glued-together documents into a single 1-2-3 escalation flow (bmad-help → source → community)
  • Remove references to deprecated _bmad folder and closed Discord channels (#bmad-method-help, #report-bugs-and-issues)
  • Remove redundant source table that duplicated the prose instructions

Test plan

  • Verify doc renders correctly on the docs site
  • Confirm all links resolve (repo, llms-full.txt, Discord, GitHub Issues)

🤖 Generated with Claude Code

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Apr 5, 2026

📝 Walkthrough

Walkthrough

Documentation page rewritten to simplify the workflow for getting answers about BMAD. The guide was condensed from a detailed multi-section approach into a 3-step numbered flow: ask bmad-help, go deeper with the BMAD-METHOD repo, or ask someone else. Removed extensive guidance on capabilities and invocation details.

Changes

Cohort / File(s) Summary
Documentation Simplification
docs/how-to/get-answers-about-bmad.md
Rewrote guidance workflow to 3-step process. Removed detailed bmad-help capability explanations, project/module behavior details, and branching instructions for repo selection. Added tips for better answers bullet list and retained platform-specific command tips.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Suggested reviewers

  • bmadcode
🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title 'docs: rewrite get-answers-about-bmad for flow and accuracy' directly and accurately summarizes the main change: restructuring documentation for improved flow and accuracy.
Description check ✅ Passed The description provides relevant details about the restructuring (1-2-3 escalation flow), removal of deprecated references, and redundant content, all of which align with the changeset.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/rewrite-get-answers

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.

Copy link
Copy Markdown

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

🧹 Nitpick comments (1)
docs/how-to/get-answers-about-bmad.md (1)

12-12: Consider removing or sourcing the “over 80%” claim.

“The bmad-help skill … handles over 80% of questions” is a strong quantitative statement without a citation. I’d suggest softening it (e.g., “handles most common questions”) unless you can link a source/metric.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/how-to/get-answers-about-bmad.md` at line 12, Update the sentence that
claims "handles over 80% of questions" about the `bmad-help` skill: either
remove the numeric claim and replace it with a softer phrasing like "handles
most common questions" or add a supporting citation/metric that validates the
"over 80%" figure; target the sentence containing the phrase "The `bmad-help`
skill ... handles over 80% of questions" and ensure the revised text includes
the new wording or a linked source.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@docs/how-to/get-answers-about-bmad.md`:
- Line 12: Update the sentence that claims "handles over 80% of questions" about
the `bmad-help` skill: either remove the numeric claim and replace it with a
softer phrasing like "handles most common questions" or add a supporting
citation/metric that validates the "over 80%" figure; target the sentence
containing the phrase "The `bmad-help` skill ... handles over 80% of questions"
and ensure the revised text includes the new wording or a linked source.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 0fdd412a-4f04-42e7-83e8-0fc4fc5d8449

📥 Commits

Reviewing files that changed from the base of the PR and between 1050415 and 9d2f1d3.

📒 Files selected for processing (1)
  • docs/how-to/get-answers-about-bmad.md

Restructure from two glued-together documents into a single
escalation flow (bmad-help → source → community). Remove
references to deprecated _bmad folder and closed Discord channels.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@alexeyv alexeyv force-pushed the docs/rewrite-get-answers branch from 9d2f1d3 to 05d1c55 Compare April 5, 2026 03:43
@alexeyv alexeyv merged commit aa48f83 into main Apr 5, 2026
5 checks passed
@alexeyv alexeyv deleted the docs/rewrite-get-answers branch April 5, 2026 03:44
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