Skip to content

docs(zh-cn): remove slash prefix from skill examples in code blocks#1893

Merged
alexeyv merged 1 commit intobmad-code-org:mainfrom
alexeyv:fix/zh-cn-slash-removal
Mar 11, 2026
Merged

docs(zh-cn): remove slash prefix from skill examples in code blocks#1893
alexeyv merged 1 commit intobmad-code-org:mainfrom
alexeyv:fix/zh-cn-slash-removal

Conversation

@alexeyv
Copy link
Copy Markdown
Collaborator

@alexeyv alexeyv commented Mar 11, 2026

Summary

Test plan

  • Verified only code block examples were changed
  • All CI checks pass locally (markdownlint, prettier, etc.)

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 11, 2026

📝 Walkthrough

Walkthrough

Three Chinese documentation files were updated to remove leading slashes from command examples. References like /bmad-help were changed to bmad-help in code blocks and accompanying text across the how-to guides.

Changes

Cohort / File(s) Summary
Chinese documentation command examples
docs/zh-cn/how-to/established-projects.md, docs/zh-cn/how-to/get-answers-about-bmad.md, docs/zh-cn/how-to/install-bmad.md
Removed leading slashes from command examples (e.g., /bmad-helpbmad-help) in code blocks and accompanying natural-language text. No functional or semantic changes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

Suggested reviewers

  • bmadcode
🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: removing slash prefixes from skill examples in code blocks across Chinese documentation files.
Description check ✅ Passed The description is directly related to the changeset, explaining the context (incomplete slash removal from PR #1892), the affected files, and the test verification performed.
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
  • Post copyable unit tests in a comment

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.

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

📥 Commits

Reviewing files that changed from the base of the PR and between 2a12c6b and 1a2c689.

📒 Files selected for processing (3)
  • docs/zh-cn/how-to/established-projects.md
  • docs/zh-cn/how-to/get-answers-about-bmad.md
  • docs/zh-cn/how-to/install-bmad.md


```
/bmad-help
bmad-help
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟠 Major

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.

@augmentcode
Copy link
Copy Markdown

augmentcode bot commented Mar 11, 2026

🤖 Augment PR Summary

Summary: Updates zh-cn how-to docs by removing the leading / from bmad-help examples inside code blocks.
Why: Keeps command examples consistent with the intended invocation format after prior prose updates.

🤖 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. 1 suggestion posted.

Fix All in Augment

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


```
/bmad-help
bmad-help
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 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:30
  • docs/zh-cn/how-to/install-bmad.md:89
  • docs/zh-cn/how-to/established-projects.md:71

Fix This in Augment

🤖 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.
@alexeyv alexeyv force-pushed the fix/zh-cn-slash-removal branch from 1a2c689 to 9745f12 Compare March 11, 2026 09:45
@alexeyv alexeyv merged commit 031a909 into bmad-code-org:main Mar 11, 2026
5 checks passed
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