Skip to content

docs: update README links to new documentation site#1274

Merged
bmadcode merged 1 commit intobmad-code-org:mainfrom
alexeyv:fix-readme-doc-links
Jan 7, 2026
Merged

docs: update README links to new documentation site#1274
bmadcode merged 1 commit intobmad-code-org:mainfrom
alexeyv:fix-readme-doc-links

Conversation

@alexeyv
Copy link
Copy Markdown
Collaborator

@alexeyv alexeyv commented Jan 7, 2026

Summary

  • Updates documentation site links in README.md to use HTTP instead of HTTPS
  • Changes all https://docs.bmad-method.org/ links to http://docs.bmad-method.org/

Test plan

  • Verify all documentation links resolve correctly

@momoadeli
Copy link
Copy Markdown

/gemini review

@alexeyv alexeyv force-pushed the fix-readme-doc-links branch from 589b1e9 to cbdfa22 Compare January 7, 2026 19:52
@alexeyv
Copy link
Copy Markdown
Collaborator Author

alexeyv commented Jan 7, 2026

@CodeRabbit review

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Jan 7, 2026

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Jan 7, 2026

📝 Walkthrough

Walkthrough

README.md is updated to replace internal relative documentation links with external HTTP(S) URLs across multiple sections including Documentation Hub, Builder Guide, Creative Workflows, and Quick Start Guide. Image source paths are also updated to reference external tutorial-specific locations.

Changes

Cohort / File(s) Summary
Documentation Links Update
README.md
Replaces internal relative paths with external URLs in Documentation Hub, Builder Guide, Creative Workflows, v4 Upgrade Guide, and Quick Links sections; updates image source path to external tutorial domain

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The PR title 'docs: update README links to new documentation site' directly matches the main change of updating documentation links in README.md.
Description check ✅ Passed The description accurately describes the changes being made: updating documentation links from HTTPS to HTTP in README.md, which aligns 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
  • Post copyable unit tests in a comment

📜 Recent review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5c76657 and cbdfa22.

📒 Files selected for processing (1)
  • README.md
🧰 Additional context used
📓 Path-based instructions (1)
**/*

⚙️ CodeRabbit configuration file

**/*: Focus on inconsistencies, contradictions, edge cases and serious issues.
Avoid commenting on minor issues such as linting, formatting and style issues.
When providing code suggestions, use GitHub's suggestion format:

<code changes>

Files:

  • README.md
🔇 Additional comments (2)
README.md (2)

70-70: Incorrect premise: README.md is a new file, not a modification

Line 70 was not changed or updated—README.md was created as a new file in this commit. There is no original value to compare. The local path ./docs/tutorials/getting-started/images/workflow-method-greenfield.svg is correct and the image file exists at that location.

Likely an incorrect or invalid review comment.


27-28: Remove this comment—the documentation site uses HTTP-only. The README.md is a new file (not an update to existing HTTPS links), and the docs.bmad-method.org domain appears to support HTTP only. There is no security regression here.

Likely an incorrect or invalid review 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.

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.

3 participants