Skip to content

docs: refine prose quality across module contribution guide#60

Merged
bmadcode merged 1 commit intomainfrom
module-contribution-guide
Apr 4, 2026
Merged

docs: refine prose quality across module contribution guide#60
bmadcode merged 1 commit intomainfrom
module-contribution-guide

Conversation

@bmadcode
Copy link
Copy Markdown
Contributor

@bmadcode bmadcode commented Apr 4, 2026

Summary

  • Diataxis refinement pass across 12 doc files targeting AI writing patterns
  • Fixes: banned vocabulary (seamless, comprehensive, facilitative), metanoia reframing, stakes inflation, hedging filler, hypophora patterns, informal/uncapitalized sentences, synonym cycling
  • No structural or technical content changes — prose-only edits

Test plan

  • Verify docs build cleanly
  • Spot-check prose changes preserve meaning

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Added comprehensive guide for publishing and distributing modules through GitHub, including marketplace configuration, repository structure examples, and pre-publish verification steps
    • Refined existing documentation across explanation sections, tutorials, and reference guides for improved clarity and consistency

Diataxis refinement pass targeting AI writing patterns. Fixes include
banned vocabulary (seamless, comprehensive, facilitative), metanoia
reframing, stakes inflation, hedging filler, hypophora patterns,
informal/uncapitalized sentences, and synonym cycling. No structural
or technical content changes.
@bmadcode bmadcode merged commit 4ffd94c into main Apr 4, 2026
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Apr 4, 2026

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 668ead36-b3bd-412b-9216-53563fc12110

📥 Commits

Reviewing files that changed from the base of the PR and between 68aa30d and 66532bf.

📒 Files selected for processing (12)
  • docs/explanation/module-configuration.md
  • docs/explanation/progressive-disclosure.md
  • docs/explanation/scripts-in-skills.md
  • docs/explanation/skill-authoring-best-practices.md
  • docs/explanation/subagent-patterns.md
  • docs/explanation/what-are-bmad-agents.md
  • docs/explanation/what-are-modules.md
  • docs/explanation/what-are-workflows.md
  • docs/how-to/distribute-your-module.md
  • docs/index.md
  • docs/reference/builder-commands.md
  • docs/tutorials/build-your-first-module.md

Walkthrough

This PR updates documentation across multiple explanation, how-to, reference, and tutorial pages with wording improvements for clarity and conciseness, plus adds a new comprehensive guide on distributing BMad modules via GitHub repositories.

Changes

Cohort / File(s) Summary
Explanation Pages - Clarity & Wording Refines
docs/explanation/module-configuration.md, docs/explanation/progressive-disclosure.md, docs/explanation/scripts-in-skills.md, docs/explanation/skill-authoring-best-practices.md, docs/explanation/subagent-patterns.md, docs/explanation/what-are-bmad-agents.md, docs/explanation/what-are-modules.md, docs/explanation/what-are-workflows.md
Refined prose and phrasing across conceptual documentation pages: improved clarity of configuration vs. standalone skills distinction, tightened semantic descriptions of parallel processing and subagent patterns, adjusted emphasis phrases, and improved flow and readability without altering logic or structure.
New Distribution Guide
docs/how-to/distribute-your-module.md
Added comprehensive documentation describing how to publish BMad modules via GitHub: covers .claude-plugin/marketplace.json manifest format, repository structure examples (single-module, standalone single-skill, multi-module marketplace), pre-publish verification steps, GitHub publishing workflow, and post-installation user capabilities.
Reference & Tutorial Updates
docs/reference/builder-commands.md, docs/tutorials/build-your-first-module.md
Narrowed command descriptions for clarity (Quality Optimize, Convert, Ideate Module) and adjusted tutorial prose for consistency, removing redundant qualifiers while preserving technical meaning.
Homepage
docs/index.md
Replaced abstract opening scenario with concrete use-case examples (PR tracking, character understanding, workflow awareness) and added punctuation refinement to Design Patterns section.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

Poem

🐰 Documentation hops along so clear,
Wording polished, precision here!
From modules new to workflows wise,
Each phrase refined before our eyes. 📚✨

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch module-contribution-guide

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.

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