Docusaurus build fix - Sidebar and missing image issues (#1243)

* fix(docs): align sidebar with actual docs structure and fix image path

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 <noreply@anthropic.com>

* fix(docs): update build script to include docs/modules directory

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 <noreply@anthropic.com>

* fix(docs): correct broken internal links

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 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
forcetrainer
2026-01-03 04:09:42 -05:00
committed by GitHub
parent 05ddc2d29b
commit d1f3844449
6 changed files with 66 additions and 70 deletions

View File

@@ -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
## Tips for Using This Documentation

View File

@@ -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)
---

View File

@@ -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)

View File

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

View File

@@ -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) {

View File

@@ -4,40 +4,56 @@ 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',
],
},
{
@@ -45,11 +61,10 @@ const sidebars = {
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',
],
},
{
@@ -57,11 +72,10 @@ const sidebars = {
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',
],
},
],
@@ -71,32 +85,11 @@ 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',
],
},
{
@@ -104,33 +97,35 @@ const sidebars = {
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',
],
},
],