docs: add modules reference page and site fixes#1540
docs: add modules reference page and site fixes#1540bmadcode merged 7 commits intobmad-code-org:mainfrom
Conversation
f5d92f2 to
1acad8e
Compare
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.
1acad8e to
b2c047f
Compare
- 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/
|
@CodeRabbit review |
✅ Actions performedReview triggered.
|
📝 WalkthroughWalkthroughThis 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 Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
Suggested reviewers
🚥 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)
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 |
- 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
* 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
Summary
docs/reference/modules.md)docs.bmad-method.orgChanges
New content:
docs/reference/modules.md— lists BMB, CIS, GDS, TEA with descriptions and linksdocs/_prompt-external-modules-page.md— generation prompt for reproducibilityFixes:
website/public/robots.txt— updated URLs todocs.bmad-method.orgwebsite/astro.config.mjs— sitemap filter excludes/bmgd/Cleanup:
tools/docs/index.mdwebsite/_basement/componentsTest plan
🤖 Generated with Claude Code