Skip to content

docs: add modules reference page and site fixes#1540

Merged
bmadcode merged 7 commits intobmad-code-org:mainfrom
alexeyv:docs/docs-review
Feb 6, 2026
Merged

docs: add modules reference page and site fixes#1540
bmadcode merged 7 commits intobmad-code-org:mainfrom
alexeyv:docs/docs-review

Conversation

@alexeyv
Copy link
Copy Markdown
Collaborator

@alexeyv alexeyv commented Feb 5, 2026

Summary

  • Add official external modules reference page (docs/reference/modules.md)
  • Fix robots.txt URLs to use docs.bmad-method.org
  • Remove obsolete docs and basement files
  • Exclude BMGD from sitemap (already excluded from llms-full.txt and sidebar)

Changes

New content:

  • docs/reference/modules.md — lists BMB, CIS, GDS, TEA with descriptions and links
  • docs/_prompt-external-modules-page.md — generation prompt for reproducibility

Fixes:

  • website/public/robots.txt — updated URLs to docs.bmad-method.org
  • website/astro.config.mjs — sitemap filter excludes /bmgd/

Cleanup:

  • Removed tools/docs/index.md
  • Removed website/_basement/ components

Test plan

  • All docs links validate
  • Docs site builds successfully
  • All tests pass

🤖 Generated with Claude Code

Replace static robots.txt with an Astro endpoint that uses the
configured site URL, so sitemap references are correct on both
fork deployments and production.
build-docs.js had its own hardcoded fallback URL
(bmad-code-org.github.io) instead of using the shared
getSiteUrl() function, causing URL mismatches between
robots.txt, llms.txt, and sitemaps. Now all components
resolve the site URL through the same function. Renamed
site-url.js to .mjs to avoid Node ESM detection warnings.
- CIS: "Creative Innovation Suite" → "Creative Intelligence Suite"
- GDS: "Game Dev Suite" → "Game Dev Studio"
- Move _prompt-external-modules-page.md from docs/ to tools/docs/
@alexeyv alexeyv marked this pull request as ready for review February 6, 2026 10:31
@alexeyv
Copy link
Copy Markdown
Collaborator Author

alexeyv commented Feb 6, 2026

@CodeRabbit review

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Feb 6, 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 Feb 6, 2026

📝 Walkthrough

Walkthrough

This PR refactors the site URL initialization system, adds Official Modules documentation with configuration updates, removes a deprecated WorkflowGuide component, introduces a dynamic robots.txt generator, and updates file extension references from .js to .mjs across the build and website systems.

Changes

Cohort / File(s) Summary
Official Modules Documentation
docs/reference/modules.md, tools/docs/_prompt-external-modules-page.md, tools/cli/external-official-modules.yaml
Adds new module reference documentation and updates display names for bmad-creative-intelligence-suite and bmad-game-dev-studio modules; includes prompt file defining structure for External Modules Reference Page generation.
SITE_URL Dynamic Resolution
tools/build-docs.js, website/astro.config.mjs, website/src/components/Banner.astro
Refactors SITE_URL from a top-level constant to a mutable variable initialized dynamically in main() via dynamic import of getSiteUrl(); updates import paths from .js to .mjs for consistency.
Dynamic Robots.txt Generator
website/src/pages/robots.txt.ts
Adds new API route that dynamically generates robots.txt content using the site URL, replacing static content with dynamic sitemap URL computation.
Component Removal
website/_basement/components/WorkflowGuide.astro, website/_basement/pages/workflow-guide.astro
Removes deprecated WorkflowGuide UI component and its associated page containing track selection, flow steps, styling, and initialization logic.
Documentation Maintenance
tools/docs/index.md
Removes top-level heading from tools documentation index.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

  • #1396: Directly inverse to this PR—adds the WorkflowGuide component and page that this PR removes.
  • #1525: Modifies tools/build-docs.js alongside this PR's SITE_URL refactoring in the same file.
  • #1243: Touches the docs build pipeline and modifies/adds modules documentation content similar to this PR.

Suggested reviewers

  • bmadcode
  • pbean
🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title 'docs: add modules reference page and site fixes' accurately summarizes the primary changes: adding a new modules reference page and addressing related site configuration issues.
Description check ✅ Passed The description is directly related to the changeset, providing a clear summary of new content, fixes, cleanup, and test validation aligned with the actual changes across multiple files.
Docstring Coverage ✅ Passed Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
  • 📝 Generate docstrings
🧪 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.

- Convert build-docs.js to build-docs.mjs (CJS → ESM)
- Import getSiteUrl directly, remove async import workaround
- Kill mutable SITE_URL global, call getSiteUrl() where needed
- Clean up Banner.astro variable naming
- Update package.json and CI workflow for .mjs extension
@alexeyv alexeyv marked this pull request as draft February 6, 2026 10:54
@alexeyv alexeyv marked this pull request as ready for review February 6, 2026 12:38
@bmadcode bmadcode merged commit 8be3713 into bmad-code-org:main Feb 6, 2026
5 checks passed
dickymoore pushed a commit to dickymoore/BMAD-METHOD that referenced this pull request Feb 6, 2026
* docs: add official external modules reference page

* chore: remove obsolete docs and basement files

* fix: update robots.txt URLs to docs.bmad-method.org

* fix: generate robots.txt dynamically from site base URL

Replace static robots.txt with an Astro endpoint that uses the
configured site URL, so sitemap references are correct on both
fork deployments and production.

* fix: unify site URL resolution in build-docs.js

build-docs.js had its own hardcoded fallback URL
(bmad-code-org.github.io) instead of using the shared
getSiteUrl() function, causing URL mismatches between
robots.txt, llms.txt, and sitemaps. Now all components
resolve the site URL through the same function. Renamed
site-url.js to .mjs to avoid Node ESM detection warnings.

* fix: correct module names and relocate prompt file

- CIS: "Creative Innovation Suite" → "Creative Intelligence Suite"
- GDS: "Game Dev Suite" → "Game Dev Studio"
- Move _prompt-external-modules-page.md from docs/ to tools/docs/

* refactor: convert build-docs to ESM, eliminate mutable globals

- Convert build-docs.js to build-docs.mjs (CJS → ESM)
- Import getSiteUrl directly, remove async import workaround
- Kill mutable SITE_URL global, call getSiteUrl() where needed
- Clean up Banner.astro variable naming
- Update package.json and CI workflow for .mjs extension
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.

2 participants