Docusaurus build fix - Sidebar and missing image issues #1243
Conversation
Sidebar referenced non-existent paths (modules/bmm/, getting-started/, etc.) while actual docs live in different locations (modules/bmm-bmad-method/, bmad-core-concepts/, etc.). Updated sidebar to match reality so Docusaurus can build successfully. Also fixed broken image reference in workflows-guide.md that used an incorrect relative path. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <[email protected]>
The build script was excluding the modules folder when copying from docs/, but module docs now live in docs/modules/ instead of src/modules/*/docs/. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <[email protected]>
Fixed relative paths that were pointing to non-existent locations: - bmgd index: ../../bmm/docs/index.md → ../bmm/index.md - cis index: ../../bmm/docs/index.md → ../bmm/index.md - bmm faq: ./README.md → GitHub URL 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <[email protected]>
|
@CodeRabbit review |
✅ Actions performedReview triggered.
|
📝 WalkthroughWalkthroughDocumentation and build configuration updates to reflect new module naming conventions. Changes migrate path structures from legacy names (e.g., Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Suggested reviewers
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ 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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
tools/build-docs.js (1)
129-173: Remove copyModuleDocs or complete the docs migration for all modules consistently.The code creates documentation at inconsistent paths:
- copyMainDocs copies
docs/modules/bmb-bmad-builder/,bmgd-bmad-game-dev/, etc. tomodules/bmb-bmad-builder/,modules/bmgd-bmad-game-dev/, etc. (long names)- copyModuleDocs attempts to copy from
src/modules/{short-name}/docs/tomodules/{short-name}/— but:
src/modules/bmb/docs/still exists and createsmodules/bmb/(short name)src/modules/bmm/,bmgd/,cis/docs don't exist; the function logs warnings for eachThis results in
bmbdocumentation appearing at two different paths (modules/bmb/andmodules/bmb-bmad-builder/), which will break sidebar navigation and links expecting the long-form path names.Action required: Either delete
copyModuleDocsand move remainingsrc/modules/bmb/docs/content todocs/modules/bmb-bmad-builder/, or remove old docs fromsrc/modules/entirely to complete the migration consistently.
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (6)
docs/modules/bmgd-bmad-game-dev/index.mddocs/modules/bmgd-bmad-game-dev/workflows-guide.mddocs/modules/bmm-bmad-method/faq.mddocs/modules/cis-creative-intelligence-suite/index.mdtools/build-docs.jswebsite/sidebars.js
🧰 Additional context used
📓 Path-based instructions (2)
**/*
⚙️ 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:
docs/modules/bmgd-bmad-game-dev/workflows-guide.mddocs/modules/cis-creative-intelligence-suite/index.mddocs/modules/bmgd-bmad-game-dev/index.mdtools/build-docs.jswebsite/sidebars.jsdocs/modules/bmm-bmad-method/faq.md
**/*.js
⚙️ CodeRabbit configuration file
**/*.js: CLI tooling code. Check for: missing error handling on fs operations,
path.join vs string concatenation, proper cleanup in error paths.
Flag any process.exit() without error message.
Files:
tools/build-docs.jswebsite/sidebars.js
🔇 Additional comments (3)
docs/modules/bmm-bmad-method/faq.md (1)
513-513: Link update looks good.Correctly updated to point to the canonical GitHub README location, consistent with the build pipeline's approach of keeping root documentation files on GitHub rather than in the docs site.
docs/modules/bmgd-bmad-game-dev/workflows-guide.md (1)
11-11: Image path update looks good.Correctly simplified from the complex
../../../../docs/modules/bmgd-bmad-game-dev/workflow-overview.jpgto the local./workflow-overview.jpg. This assumes the image file exists in the same directory as the markdown file, which aligns with the new documentation structure.website/sidebars.js (1)
1-134: Sidebar configuration is correctly aligned with documentation structure.All 49 referenced documentation paths exist in the docs folder. The sidebar configuration follows Docusaurus conventions and maintains consistent naming patterns across modules:
bmad-core-concepts/*paths verifiedmodules/bmm-bmad-method/*paths verifiedmodules/bmb-bmad-builder/*paths verifiedmodules/bmgd-bmad-game-dev/*paths verifiedmodules/cis-creative-intelligence-suite/*paths verifiedmodules/core/*paths verifiedThe changes successfully align the sidebar with the actual documentation structure.
| ### Related Documentation | ||
|
|
||
| - **[BMM Documentation](../../bmm/docs/index.md)** - Core BMad Method documentation | ||
| - **[BMM Documentation](../bmm/index.md)** - Core BMad Method documentation |
There was a problem hiding this comment.
Incorrect path: link points to ../bmm/ but folder is bmm-bmad-method/.
The PR migrates the BMM module from modules/bmm/ to modules/bmm-bmad-method/, but this link still uses the old short name.
Current link: ../bmm/index.md
Expected path: ../bmm-bmad-method/index.md
This will result in a broken link (404) when the docs are built.
🔎 Fix the documentation link path
| - **[BMM Documentation](../bmm/index.md)** - Core BMad Method documentation | |
| - **[BMM Documentation](../bmm-bmad-method/index.md)** - Core BMad Method documentation |
🤖 Prompt for AI Agents
In docs/modules/bmgd-bmad-game-dev/index.md around line 164 the link targets the
old module path ../bmm/index.md which no longer exists; update the link to
../bmm-bmad-method/index.md so it points to the migrated BMM module (replace
../bmm/index.md with ../bmm-bmad-method/index.md).
| ## Related Documentation | ||
|
|
||
| - **[BMM Documentation](../../bmm/docs/index.md)** - Core BMad Method documentation | ||
| - **[BMM Documentation](../bmm/index.md)** - Core BMad Method documentation |
There was a problem hiding this comment.
Incorrect path: link points to ../bmm/ but folder is bmm-bmad-method/.
Same issue as in the BMGD index file. The BMM module folder is now bmm-bmad-method, not bmm.
Current link: ../bmm/index.md
Expected path: ../bmm-bmad-method/index.md
🔎 Fix the documentation link path
| - **[BMM Documentation](../bmm/index.md)** - Core BMad Method documentation | |
| - **[BMM Documentation](../bmm-bmad-method/index.md)** - Core BMad Method documentation |
🤖 Prompt for AI Agents
In docs/modules/cis-creative-intelligence-suite/index.md around line 145, the
documentation link targets the wrong folder (`../bmm/index.md`); update the link
to point to the renamed folder by changing the path to
`../bmm-bmad-method/index.md` so the markdown link resolves to the correct BMM
module index file.
There was a problem hiding this comment.
These issues were noted during build, and since the docs are going to be moved completely to new directories, the focus on this PR was to get the build flow working again.
There was a problem hiding this comment.
@forcetrainer, understood! Makes sense to focus on getting the build working first. Since you're planning a broader docs reorganization, it's fine to address these path inconsistencies as part of that future work. Thanks for the context! 👍
|
Thanks @forcetrainer ! |
3 participants
Summary
website/sidebars.jsto match actual docs folder structure (paths likemodules/bmm-bmad-method/instead of non-existentmodules/bmm/)workflows-guide.mdthat prevented Docusaurus from buildingPrep work for documentation update so the pages build properly on commit.