Skip to content

Docusaurus build fix - Sidebar and missing image issues #1243

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bmadcode merged 3 commits into from
Jan 3, 2026
Merged

Docusaurus build fix - Sidebar and missing image issues #1243

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cd11414
fix(docs): align sidebar with actual docs structure and fix image path
forcetrainer Jan 3, 2026
33566b8
fix(docs): update build script to include docs/modules directory
forcetrainer Jan 3, 2026
22ccc20
fix(docs): correct broken internal links
forcetrainer Jan 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/modules/bmgd-bmad-game-dev/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ BMGD Documentation

### Related Documentation

- **[BMM Documentation](../../bmm/docs/index.md)** - Core BMad Method documentation
- **[BMM Documentation](../bmm/index.md)** - Core BMad Method documentation
Copy link

@coderabbitai coderabbitai bot Jan 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🔴 Critical

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
Suggested change
- **[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).


## Tips for Using This Documentation

Expand Down
2 changes: 1 addition & 1 deletion docs/modules/bmgd-bmad-game-dev/workflows-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Complete reference for all BMGD workflows organized by development phase.

BMGD workflows are organized into four phases:

![BMGD Workflow Overview](../../../../docs/modules/bmgd-bmad-game-dev/workflow-overview.jpg)
![BMGD Workflow Overview](./workflow-overview.jpg)

---

Expand Down
2 changes: 1 addition & 1 deletion docs/modules/bmm-bmad-method/faq.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -510,7 +510,7 @@ Trust your expertise - BMM supports your decisions.

**A:**

1. Search [Complete Documentation](./README.md) for related topics
1. Search [Complete Documentation](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/README.md) for related topics
2. Ask in [Discord Community](https://discord.gg/gk8jAdXWmj) (#general-dev)
3. Open a [GitHub Issue](https://github.com/bmad-code-org/BMAD-METHOD/issues)
4. Watch [YouTube Tutorials](https://www.youtube.com/@BMadCode)
Expand Down
2 changes: 1 addition & 1 deletion docs/modules/cis-creative-intelligence-suite/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ CIS workflows integrate with:

## Related Documentation

- **[BMM Documentation](../../bmm/docs/index.md)** - Core BMad Method documentation
- **[BMM Documentation](../bmm/index.md)** - Core BMad Method documentation
Copy link

@coderabbitai coderabbitai bot Jan 3, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🔴 Critical

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
Suggested change
- **[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.

Copy link
Contributor Author

@forcetrainer forcetrainer Jan 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link

@coderabbitai coderabbitai bot Jan 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@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! 👍


---

Expand Down
3 changes: 2 additions & 1 deletion tools/build-docs.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,8 @@ function buildDocusaurusSite(artifactsDir) {
function copyMainDocs(destDir) {
console.log(' → Copying main docs...');
const docsDir = path.join(PROJECT_ROOT, 'docs');
copyDirectory(docsDir, destDir, ['modules', 'llms.txt', 'llms-full.txt'], true);
// Include modules folder - docs now live in docs/modules/ instead of src/modules/*/docs/
copyDirectory(docsDir, destDir, ['llms.txt', 'llms-full.txt'], true);
}

function copyRootDocs(destDir) {
Expand Down
125 changes: 60 additions & 65 deletions website/sidebars.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,64 +4,78 @@ const sidebars = {
'index',
{
type: 'category',
label: 'Getting Started',
label: 'Core Concepts',
items: [
'getting-started/installation',
'bmad-core-concepts/index',
'bmad-core-concepts/agents',
'bmad-core-concepts/workflows',
'bmad-core-concepts/modules',
{
type: 'category',
label: 'IDE Guides',
label: 'Installing',
collapsed: true,
items: [],
items: ['bmad-core-concepts/installing/index', 'bmad-core-concepts/installing/upgrading'],
},
'v4-to-v6-upgrade',
{
type: 'category',
label: 'Customization',
collapsed: true,
items: [
'bmad-core-concepts/bmad-customization/index',
'bmad-core-concepts/bmad-customization/agents',
'bmad-core-concepts/bmad-customization/workflows',
],
},
'bmad-core-concepts/web-bundles/index',
],
},
{
type: 'category',
label: 'BMM - Method',
items: [
'modules/bmm/index',
'modules/bmm/quick-start',
'modules/bmm/scale-adaptive-system',
'modules/bmm-bmad-method/index',
'modules/bmm-bmad-method/quick-start',
{
type: 'category',
label: 'Quick Flows',
collapsed: true,
items: ['modules/bmm/bmad-quick-flow', 'modules/bmm/quick-flow-solo-dev', 'modules/bmm/quick-spec-flow'],
items: [
'modules/bmm-bmad-method/bmad-quick-flow',
'modules/bmm-bmad-method/quick-flow-solo-dev',
'modules/bmm-bmad-method/quick-spec-flow',
],
},
{
type: 'category',
label: 'Workflows',
collapsed: true,
items: [
'modules/bmm/workflows-planning',
'modules/bmm/workflows-solutioning',
'modules/bmm/workflows-analysis',
'modules/bmm/workflows-implementation',
'modules/bmm-bmad-method/workflows-planning',
'modules/bmm-bmad-method/workflows-solutioning',
'modules/bmm-bmad-method/workflows-analysis',
'modules/bmm-bmad-method/workflows-implementation',
],
},
{
type: 'category',
label: 'Advanced Topics',
collapsed: true,
items: [
'modules/bmm/party-mode',
'modules/bmm/agents-guide',
'modules/bmm/brownfield-guide',
'modules/bmm/enterprise-agentic-development',
'modules/bmm/test-architecture',
'modules/bmm-bmad-method/party-mode',
'modules/bmm-bmad-method/agents-guide',
'modules/bmm-bmad-method/brownfield-guide',
'modules/bmm-bmad-method/test-architecture',
],
},
{
type: 'category',
label: 'Reference',
collapsed: true,
items: [
'modules/bmm/workflow-architecture-reference',
'modules/bmm/workflow-document-project-reference',
'modules/bmm/troubleshooting',
'modules/bmm/faq',
'modules/bmm/glossary',
'modules/bmm-bmad-method/workflow-document-project-reference',
'modules/bmm-bmad-method/troubleshooting',
'modules/bmm-bmad-method/faq',
'modules/bmm-bmad-method/glossary',
],
},
],
Expand All @@ -71,66 +85,47 @@ const sidebars = {
label: 'BMB - Builder',
collapsed: true,
items: [
'modules/bmb/index',
{
type: 'category',
label: 'Building Agents',
collapsed: true,
items: [
'modules/bmb/agents/index',
'modules/bmb/agents/understanding-agent-types',
'modules/bmb/agents/simple-agent-architecture',
'modules/bmb/agents/expert-agent-architecture',
'modules/bmb/agents/agent-compilation',
'modules/bmb/agents/agent-menu-patterns',
],
},
{
type: 'category',
label: 'Building Workflows',
collapsed: true,
items: [
'modules/bmb/workflows/index',
'modules/bmb/workflows/architecture',
'modules/bmb/workflows/terms',
'modules/bmb/workflows/intent-vs-prescriptive-spectrum',
'modules/bmb/workflows/csv-data-file-standards',
],
},
'modules/bmb-bmad-builder/index',
'modules/bmb-bmad-builder/agent-creation-guide',
'modules/bmb-bmad-builder/workflow-vendoring-customization-inheritance',
'modules/bmb-bmad-builder/custom-content',
'modules/bmb-bmad-builder/custom-content-installation',
],
},
{
type: 'category',
label: 'BMGD - Game Dev',
collapsed: true,
items: [
'modules/bmgd/index',
'modules/bmgd/quick-start',
'modules/bmgd/quick-flow-guide',
'modules/bmgd/agents-guide',
'modules/bmgd/workflows-guide',
'modules/bmgd/game-types-guide',
'modules/bmgd/troubleshooting',
'modules/bmgd/glossary',
'modules/bmgd-bmad-game-dev/index',
'modules/bmgd-bmad-game-dev/quick-start',
'modules/bmgd-bmad-game-dev/quick-flow-guide',
'modules/bmgd-bmad-game-dev/agents-guide',
'modules/bmgd-bmad-game-dev/workflows-guide',
'modules/bmgd-bmad-game-dev/game-types-guide',
'modules/bmgd-bmad-game-dev/troubleshooting',
'modules/bmgd-bmad-game-dev/glossary',
],
},
{
type: 'category',
label: 'CIS - Creative Intelligence',
collapsed: true,
items: ['modules/cis/index'],
items: ['modules/cis-creative-intelligence-suite/index'],
},
{
type: 'category',
label: 'Reference',
label: 'Core Module',
collapsed: true,
items: [
'document-sharding-guide',
'custom-content',
'custom-content-installation',
'agent-customization-guide',
'web-bundles-gemini-gpt-guide',
'BUNDLE_DISTRIBUTION_SETUP',
'modules/core/index',
'modules/core/party-mode',
'modules/core/core-tasks',
'modules/core/core-workflows',
'modules/core/advanced-elicitation',
'modules/core/brainstorming',
'modules/core/document-sharding-guide',
'modules/core/global-core-config',
],
},
],
Expand Down