Skip to content

docs: Create troubleshooting guide for common issues #7671

Description

@BARBOUCHEEMNA

Proposal: Create "Troubleshooting" Section

Current State:
Users struggle with rendering issues, syntax errors, and configuration problems with no dedicated troubleshooting guide.

Proposed Solution:

Create troubleshooting.md:

# Troubleshooting Mermaid Diagrams

## Common Issues and Solutions

### Issue 1: Diagram Not Rendering

Symptoms:  
- Blank output
- No error messages
- Live Editor works but site doesn't

Solutions:
1. Check script is loaded: `<script src="...mermaid.min.js"></script>`
2. Call `mermaid.contentLoaded()` after HTML loads
3. Check for syntax errors using Live Editor
4. Ensure `<div class="mermaid">` wraps diagram

### Issue 2: Nested Boxes Not Working

Symptoms:  
- Nesting syntax doesn't render
- Actors disappear
- Boxes render flat

Solutions:
1. Ensure proper indentation
2. Each level must have `box...end`
3. Actors only at deepest level
4. Test in Live Editor first

### Issue 3: Colors Not Applying

Symptoms:  
- color:#XXXXXX not working
- Styles from CSS ignored
- Theme changes have no effect

Solutions:
1. Use hex format: `color:#FF6B6B` (not `color: red`)
2. Verify 6-digit hex codes
3. Check if theme overrides custom colors
4. Ensure `classDef` applied correctly

### Issue 4: Syntax Errors

Symptoms:  
- "Unexpected token" errors
- Diagram won't render
- Error message in console

Solutions:
1. Copy syntax from Live Editor
2. Check matching brackets/quotes
3. Use provided templates
4. Validate in Live Editor first
5. Check for special characters

### Issue 5: Performance Issues

Symptoms:  
- Slow rendering
- Browser lag
- Freezes with large diagrams

Solutions:
1. Break into smaller diagrams
2. Reduce complexity
3. Use simple styling
4. Update Mermaid to latest version
5. Check browser console for errors

Metadata

Metadata

Assignees

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions