Files
BMAD-METHOD/docs/how-to/troubleshooting/bmgd-troubleshooting.md
Alex Verkhovsky 2e16650067 feat(docs): Diataxis restructure + Astro/Starlight migration (#1263)
* feat(docs): add Diataxis folder structure and update sidebar styling

- Create tutorials, how-to, explanation, reference directories with subdirectories
- Add index.md files for each main Diataxis section
- Update homepage with Diataxis card navigation layout
- Implement clean React Native-inspired sidebar styling
- Convert sidebar to autogenerated for both Diataxis and legacy sections
- Update docusaurus config with dark mode default and navbar changes

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* feat(docs): migrate Phase 1 files to Diataxis structure

Move 21 files to new locations:
- Tutorials: quick-start guides, agent creation guide
- How-To: installation, customization, workflows
- Explanation: core concepts, features, game-dev, builder
- Reference: merged glossary from BMM and BMGD

Also:
- Copy images to new locations
- Update internal links via migration script (73 links updated)
- Build verified successfully

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* fix(docs): add category labels for sidebar folders

Add _category_.json files to control display labels and position
for autogenerated sidebar categories.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* style(docs): improve welcome page and visual styling

- Rewrite index.md with React Native-inspired welcoming layout
- Add Diataxis section cards with descriptions
- Remove sidebar separator, add spacing instead
- Increase navbar padding with responsive breakpoints
- Add rounded admonitions without left border bar
- Use system font stack for better readability
- Add lighter chevron styling in sidebar
- Constrain max-width to 1600px for wide viewports

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* fix: use baseUrl in meta tag paths for correct deployment URLs

* feat(docs): complete Phase 2 - split files and fix broken links

Phase 2 of Diataxis migration:
- Split 16 large legacy files into 42+ focused documents
- Created FAQ section with 7 topic-specific files
- Created brownfield how-to guides (3 files)
- Created workflow how-to guides (15+ files)
- Created architecture explanation files (3 files)
- Created TEA/testing explanation files
- Moved remaining legacy module files to proper Diataxis locations

Link fixes:
- Fixed ~50 broken internal links across documentation
- Updated relative paths for new file locations
- Created missing index files for installation, advanced tutorials
- Simplified TOC anchors to fix Docusaurus warnings

Cleanup:
- Removed legacy sidebar entries for deleted folders
- Deleted duplicate and empty placeholder files
- Moved workflow diagram assets to tutorials/images

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* fix(build): use file glob instead of sidebar parsing for llms-full.txt

Replace brittle sidebar.js regex parsing with recursive file glob.
The old approach captured non-file strings like 'autogenerated' and
category labels, resulting in only 5 files being processed.

Now correctly processes all 86+ markdown files (~95k tokens).

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* fix(seo): use absolute URLs in AI meta tags for agent discoverability

AI web-browsing agents couldn't follow relative paths in meta tags due to
URL security restrictions. Changed llms-full.txt and llms.txt meta tag
URLs from relative (baseUrl) to absolute (urlParts.origin + baseUrl).

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* refactor(docs): recategorize misplaced files per Diataxis analysis

Phase 2.5 categorization fixes based on post-migration analysis:

Moved to correct Diataxis categories:
- tutorials/installation.md → deleted (duplicate of how-to/install-bmad.md)
- tutorials/brownfield-onboarding.md → how-to/brownfield/index.md
- reference/faq/* (8 files) → explanation/faq/
- reference/agents/barry-quick-flow.md → explanation/agents/
- reference/agents/bmgd-agents.md → explanation/game-dev/agents.md

Created:
- explanation/agents/index.md

Fixed all broken internal links (14 total)

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* feat(docs): add Getting Started tutorial and simplify build script

- Add comprehensive Getting Started tutorial with installation as Step 1
- Simplify build-docs.js to read directly from docs/ (no consolidation)
- Remove backup/restore dance that could corrupt docs folder on build failure
- Remove ~150 lines of unused consolidation code

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* fix(css): use fixed width layout to prevent content shifting

Apply React Native docs approach: set both width and max-width at
largest breakpoint (1400px) so content area maintains consistent
size regardless of content length. Switches to fluid 100% below
1416px breakpoint.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* refactor(docs): restructure tutorials with renamed entry point

- Rename index.md to bmad-tutorial.md for clearer navigation
- Remove redundant tutorials/index.md
- Update sidebar and config references

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* feat(docs): add tutorial style guide and AI agent announcement bar

- Add docs/_contributing/ with tutorial style guide
- Reformat quick-start-bmm.md and bmad-tutorial.md per style guide
- Remove horizontal separators, add strategic admonitions
- Add persistent announcement bar for AI agents directing to llms-full.txt
- Fix footer broken link to tutorials

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* feat(docs): add markdown demo page and UI refinements

- Add comprehensive markdown-demo.md for style testing
- Remove doc category links from navbar (use sidebar instead)
- Remove card buttons from welcome page
- Add dark mode styling for announcement bar
- Clean up index.md card layout

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* feat(docs): apply unified tutorial style and update references

- Reformat create-custom-agent.md to follow tutorial style guide
- Update tutorial-style.md with complete unified structure
- Update all internal references to renamed tutorial files
- Remove obsolete advanced/index.md

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* refactor(docs): migrate from Docusaurus to Astro+Starlight

Replace Docusaurus with Astro and the Starlight documentation theme
for improved performance, better customization, and modern tooling.

Build pipeline changes:
- New build-docs.js orchestrates link checking, artifact generation,
  and Astro build in sequence
- Add check-doc-links.js for validating internal links and anchors
- Generate llms.txt and llms-full.txt for LLM-friendly documentation
- Create downloadable source bundles (bmad-sources.zip, bmad-prompts.zip)
- Suppress MODULE_TYPELESS_PACKAGE_JSON warning in Astro build
- Output directly to build/site for cleaner deployment

Website architecture:
- Add rehype-markdown-links.js plugin to transform .md links to routes
- Add site-url.js helper for GitHub Pages URL resolution with strict
  validation (throws on invalid GITHUB_REPOSITORY format)
- Custom Astro components: Banner, Header, MobileMenuFooter
- Symlink docs/ into website/src/content/docs for Starlight

Documentation cleanup:
- Remove Docusaurus _category_.json files (Starlight uses frontmatter)
- Convert all docs to use YAML frontmatter with title field
- Move downloads.md from website/src/pages to docs/
- Consolidate style guide and workflow diagram docs
- Add 404.md and tutorials/index.md

---------

Co-authored-by: forcetrainer <bryan@inagaki.us>
Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-07 14:42:15 +08:00

5.9 KiB

title
title
BMGD Troubleshooting

Common issues and solutions when using BMGD workflows.


Installation Issues

BMGD module not appearing

Symptom: BMGD agents and workflows are not available after installation.

Solutions:

  1. Verify BMGD was selected during installation
  2. Check _bmad/bmgd/ folder exists in your project
  3. Re-run installer with --add-module bmgd

Config file missing

Symptom: Workflows fail with "config not found" errors.

Solution: Check for _bmad/bmgd/config.yaml in your project. If missing, create it:

output_folder: '{project-root}/docs/game-design'
user_name: 'Your Name'
communication_language: 'English'
document_output_language: 'English'
game_dev_experience: 'intermediate'

Workflow Issues

"GDD not found" in Narrative workflow

Symptom: Narrative workflow can't find the GDD.

Solutions:

  1. Ensure GDD exists in {output_folder}
  2. Check GDD filename contains "gdd" (e.g., game-gdd.md, my-gdd.md)
  3. If using sharded GDD, verify {output_folder}/gdd/index.md exists

Workflow state not persisting

Symptom: Returning to a workflow starts from the beginning.

Solutions:

  1. Check the output document's frontmatter for stepsCompleted array
  2. Ensure document was saved before ending session
  3. Use "Continue existing" option when re-entering workflow

Wrong game type sections in GDD

Symptom: GDD includes irrelevant sections for your game type.

Solutions:

  1. Review game type selection at Step 7 of GDD workflow
  2. You can select multiple types for hybrid games
  3. Irrelevant sections can be marked N/A or removed

Agent Issues

Agent not recognizing commands

Symptom: Typing a command like create-gdd doesn't trigger the workflow.

Solutions:

  1. Ensure you're chatting with the correct agent (Game Designer for GDD)
  2. Check exact command spelling (case-sensitive)
  3. Try workflow-status to verify agent is loaded correctly

Agent using wrong persona

Symptom: Agent responses don't match expected personality.

Solutions:

  1. Verify correct agent file is loaded
  2. Check _bmad/bmgd/agents/ for agent definitions
  3. Start a fresh chat session with the correct agent

Document Issues

Document too large for context

Symptom: AI can't process the entire GDD or narrative document.

Solutions:

  1. Use sharded document structure (index.md + section files)
  2. Request specific sections rather than full document
  3. GDD workflow supports automatic sharding for large documents

Template placeholders not replaced

Symptom: Output contains {{placeholder}} text.

Solutions:

  1. Workflow may have been interrupted before completion
  2. Re-run the specific step that generates that section
  3. Manually edit the document to fill in missing values

Frontmatter parsing errors

Symptom: YAML errors when loading documents.

Solutions:

  1. Validate YAML syntax (proper indentation, quotes around special characters)
  2. Check for tabs vs spaces (YAML requires spaces)
  3. Ensure frontmatter is bounded by --- markers

Phase 4 (Production) Issues

Sprint status not updating

Symptom: Story status changes don't reflect in sprint-status.yaml.

Solutions:

  1. Run sprint-planning to refresh status
  2. Check file permissions on sprint-status.yaml
  3. Verify workflow-install files exist in _bmad/bmgd/workflows/4-production/

Story context missing code references

Symptom: Generated story context doesn't include relevant code.

Solutions:

  1. Ensure project-context.md exists and is current
  2. Check that architecture document references correct file paths
  3. Story may need more specific file references in acceptance criteria

Code review not finding issues

Symptom: Code review passes but bugs exist.

Solutions:

  1. Code review is AI-assisted, not comprehensive testing
  2. Always run actual tests before marking story done
  3. Consider manual review for critical code paths

Performance Issues

Workflows running slowly

Symptom: Long wait times between workflow steps.

Solutions:

  1. Use IDE-based workflows (faster than web)
  2. Keep documents concise (avoid unnecessary detail)
  3. Use sharded documents for large projects

Context limit reached mid-workflow

Symptom: Workflow stops or loses context partway through.

Solutions:

  1. Save progress frequently (workflows auto-save on Continue)
  2. Break complex sections into multiple sessions
  3. Use step-file architecture (workflows resume from last step)

Common Error Messages

"Input file not found"

Cause: Workflow requires a document that doesn't exist.

Fix: Complete prerequisite workflow first (e.g., Game Brief before GDD).


"Invalid game type"

Cause: Selected game type not in supported list.

Fix: Check game-types.csv for valid type IDs.


"Validation failed"

Cause: Document doesn't meet checklist requirements.

Fix: Review the validation output and address flagged items.


Getting Help

Community Support

Self-Help

  1. Check workflow-status to understand current state
  2. Review workflow markdown files for expected behavior
  3. Look at completed example documents in the module

Reporting Issues

When reporting issues, include:

  1. Which workflow and step
  2. Error message (if any)
  3. Relevant document frontmatter
  4. Steps to reproduce

Next Steps