docs(zh-cn): remove slash prefix from skill examples in code blocks#1893
docs(zh-cn): remove slash prefix from skill examples in code blocks#1893alexeyv merged 1 commit intobmad-code-org:mainfrom
Conversation
📝 WalkthroughWalkthroughThree Chinese documentation files were updated to remove leading slashes from command examples. References like Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 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 |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 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/zh-cn/how-to/get-answers-about-bmad.md`:
- Line 24: The examples currently show the bare command "bmad-help" which
contradicts the page text and the canonical English usage; change the example
fences back to the slash-prefixed invocation "/bmad-help" (and update the other
example occurrences around the same block) so the examples match BMAD-METHOD
docs and the surrounding instructional text, or alternatively rewrite the
surrounding copy to explicitly state why an unprefixed form is being
demonstrated if you intentionally want to keep "bmad-help"; update the example
blocks referencing "bmad-help" and any nearby repeats (the second example group)
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: 4d090061-08ce-4b61-afbc-22522d22b661
📒 Files selected for processing (3)
docs/zh-cn/how-to/established-projects.mddocs/zh-cn/how-to/get-answers-about-bmad.mddocs/zh-cn/how-to/install-bmad.md
|
|
||
| ``` | ||
| /bmad-help | ||
| bmad-help |
There was a problem hiding this comment.
These examples now contradict the page’s own instructions.
Line 21 still says to run BMad-Help as a slash command, and the canonical English version of this section shows /bmad-help in both example blocks. Changing just these fences to bare bmad-help turns the usage guide into a self-contradiction and weakens the doc that is supposed to teach the invocation syntax. Restore the slash here, or rewrite the surrounding copy to explicitly explain why this page is using a different form. Based on learnings: in BMAD-METHOD documentation under docs/, slash-prefixed skill invocations such as /bmad-help are correct and intentional IDE syntax.
Also applies to: 30-33
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/zh-cn/how-to/get-answers-about-bmad.md` at line 24, The examples
currently show the bare command "bmad-help" which contradicts the page text and
the canonical English usage; change the example fences back to the
slash-prefixed invocation "/bmad-help" (and update the other example occurrences
around the same block) so the examples match BMAD-METHOD docs and the
surrounding instructional text, or alternatively rewrite the surrounding copy to
explicitly state why an unprefixed form is being demonstrated if you
intentionally want to keep "bmad-help"; update the example blocks referencing
"bmad-help" and any nearby repeats (the second example group) accordingly.
🤖 Augment PR SummarySummary: Updates zh-cn how-to docs by removing the leading 🤖 Was this summary useful? React with 👍 or 👎 |
|
|
||
| ``` | ||
| /bmad-help | ||
| bmad-help |
There was a problem hiding this comment.
The surrounding text still describes /bmad-help as a slash command, but these code-block examples now show bmad-help without /; consider aligning the wording/examples so readers know the correct invocation format.
Severity: medium
Other Locations
docs/zh-cn/how-to/get-answers-about-bmad.md:30docs/zh-cn/how-to/install-bmad.md:89docs/zh-cn/how-to/established-projects.md:71
🤖 Was this useful? React with 👍 or 👎, or 🚀 if it prevented an incident/outage.
The PR that dropped slash-command prefixes from skill references missed updating code block examples in three Chinese how-to docs.
1a2c689 to
9745f12
Compare
Summary
/bmad-helpafter PR docs: drop slash-command prefix from skill references #1892 updated the prose tobmad-helpget-answers-about-bmad.md,install-bmad.md, andestablished-projects.mdTest plan