fix: correct docs domain to docs.bmad-method.org#1776
fix: correct docs domain to docs.bmad-method.org#1776fuleinist wants to merge 2 commits intobmad-code-org:mainfrom
Conversation
Fixes BMAD-METHOD#1712
📝 WalkthroughWalkthroughUpdated the installation start message configuration to replace a documentation URL from a relative domain to an absolute HTTPS URL (docs.bmad-method.com → https://docs.bmad-method.org), with no other structural changes. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes 🚥 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)
Tip Try Coding Plans. Let us write the prompt for your AI agent so you can ship faster (with fewer bugs). 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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
tools/cli/installers/install-messages.yaml (1)
28-34: Minor: URL formatting inconsistency.Trailing slash usage is inconsistent across URLs in this file:
- Line 28:
https://github.com/bmad-code-org/BMAD-METHOD/(has trailing slash)- Line 15:
https://docs.bmad-method.org(no trailing slash)This is a nitpick, but consistent URL formatting improves maintainability. Consider adding a trailing slash to the docs URL for consistency, or removing them from others.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@tools/cli/installers/install-messages.yaml` around lines 28 - 34, Update the URLs in install-messages.yaml to use consistent trailing-slash formatting: change the docs URL `https://docs.bmad-method.org` to `https://docs.bmad-method.org/` so it matches the trailing-slash style used by `https://github.com/bmad-code-org/BMAD-METHOD/` (and review other entries such as `https://www.youtube.com/@BMadCode`, `https://discord.gg/gk8jAdXWmj`, and `https://buymeacoffee.com/bmad` to ensure consistent trailing-slash usage across the file).
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@tools/cli/installers/install-messages.yaml`:
- Line 15: Update README.md to replace all six occurrences of
"http://docs.bmad-method.org" with the HTTPS version matching the rest of the
codebase and pick a consistent trailing-slash convention (either always include
or always omit the trailing slash); then apply that convention uniformly across
files referenced in this change (specifically update README.md entries and
tools/cli/installers/install-messages.yaml and
tools/cli/installers/lib/core/installer.js so they all use the same form of
"https://docs.bmad-method.org" with or without the trailing slash). Ensure
string literals and documentation links are changed exactly (search for
"http://docs.bmad-method.org" and the existing "https://docs.bmad-method.org"
variants) so no HTTP links remain and all files consistently use the chosen
trailing-slash style.
---
Nitpick comments:
In `@tools/cli/installers/install-messages.yaml`:
- Around line 28-34: Update the URLs in install-messages.yaml to use consistent
trailing-slash formatting: change the docs URL `https://docs.bmad-method.org` to
`https://docs.bmad-method.org/` so it matches the trailing-slash style used by
`https://github.com/bmad-code-org/BMAD-METHOD/` (and review other entries such
as `https://www.youtube.com/@BMadCode`, `https://discord.gg/gk8jAdXWmj`, and
`https://buymeacoffee.com/bmad` to ensure consistent trailing-slash usage across
the file).
| - New BMad Method for Agile AI-Driven Development (the evolution of V4) | ||
| - Exciting new modules available during installation, with community modules coming soon | ||
| - Documentation: docs.bmad-method.com | ||
| - Documentation: https://docs.bmad-method.org |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
# Read the full file to understand context
cat -n tools/cli/installers/install-messages.yamlRepository: bmad-code-org/BMAD-METHOD
Length of output: 2113
🏁 Script executed:
# Search for references to the old domain
rg "docs\.bmad-method\.com" --type yaml --type md --type txt -iRepository: bmad-code-org/BMAD-METHOD
Length of output: 51
🏁 Script executed:
# Search for any bmad-method domain references
rg "bmad-method\.(com|org)" -iRepository: bmad-code-org/BMAD-METHOD
Length of output: 1197
🏁 Script executed:
# Check if there are other .com domains in the same file that should be .org
rg "https://.*\.com" tools/cli/installers/install-messages.yamlRepository: bmad-code-org/BMAD-METHOD
Length of output: 331
Update README.md to use HTTPS for documentation URLs — critical security inconsistency.
The change to https://docs.bmad-method.org is correct and the old domain has been removed from this file. However, README.md still contains six references to http://docs.bmad-method.org (HTTP, not HTTPS), creating an inconsistency. Update these references to match the HTTPS protocol used elsewhere in the codebase.
Additionally, standardize trailing slash usage: tools/cli/installers/lib/core/installer.js uses https://docs.bmad-method.org/ (with slash) while this file uses https://docs.bmad-method.org (without). Choose one convention and apply consistently across all files.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@tools/cli/installers/install-messages.yaml` at line 15, Update README.md to
replace all six occurrences of "http://docs.bmad-method.org" with the HTTPS
version matching the rest of the codebase and pick a consistent trailing-slash
convention (either always include or always omit the trailing slash); then apply
that convention uniformly across files referenced in this change (specifically
update README.md entries and tools/cli/installers/install-messages.yaml and
tools/cli/installers/lib/core/installer.js so they all use the same form of
"https://docs.bmad-method.org" with or without the trailing slash). Ensure
string literals and documentation links are changed exactly (search for
"http://docs.bmad-method.org" and the existing "https://docs.bmad-method.org"
variants) so no HTTP links remain and all files consistently use the chosen
trailing-slash style.
- Changed http:// to https:// across README.md and issue templates - Addresses review comments on PR bmad-code-org#1776
* fix: correct docs domain to docs.bmad-method.org Fixes BMAD-METHOD#1712 * fix: update all docs.bmad-method.org links to HTTPS - Changed http:// to https:// across README.md and issue templates - Addresses review comments on PR #1776 --------- Co-authored-by: OpenClaw Assistant <assistant@openclaw.ai>
1 participant
Fixes BMAD-METHOD #1712