Repository navigation
[Child of #652] Audit: Validate Mermaid Syntax in All Diagrams #668
Description
Overview
Validate Mermaid diagram syntax across all README files to identify and document parsing errors.
Scope
- For each README with Mermaid diagrams, validate syntax
- Check for parse errors in each diagram
- Verify diagram type is supported by Mermaid
- Test rendering in Mermaid Live Editor
- Document specific errors and required fixes
Audit Checklist
- Extract all Mermaid diagrams from READMEs
- Test each diagram in Mermaid Live Editor
- Document any syntax errors found
- Verify diagram type (flowchart, sequence, state, etc.)
- Check for unsupported diagram types
- Document specific line numbers of errors
- Create list of diagrams needing fixes
Deliverables
- Mermaid syntax validation report
- List of diagrams with errors
- Specific error descriptions and line numbers
- Recommendations for fixes
- Spreadsheet: README | Diagram Type | Has Error | Error Description | Severity
Related Files
- All README.md files with Mermaid diagrams
- Mermaid documentation
Related Documentation
Definition of Ready (DoR)
- Clear problem statement and expected outcome
- Acceptance criteria defined
- Related issues/dependencies identified
- Required resources/approvals listed
Definition of Done (DoD)
- All acceptance criteria met
- Changes tested and validated
- Documentation updated
- Changes merged and deployed
- Stakeholders notified
Metadata
Metadata
Assignees
Type
Fields
Priority
None yet
Activity
linear-code commentedon May 31, 2026
LS-842
LS-1144
Fix markdown linting errors - add blank lines around headings and lists
Wave 5.4 Discovery Audit: README & Mermaid Diagram Inventory
Fix markdown linting errors - add blank lines around headings and lists
Wave 5.4 Discovery: Complete README & Mermaid Diagram Audit (#667) (#687
feat(#668): Add Mermaid diagram syntax validation
fix(#668): Improve Mermaid validation script based on code review
fix(#668): Add frontmatter to mermaid-diagram-audit.md
fix(#668): Use correct file_type in frontmatter
feat(#668): Add Mermaid diagram syntax validation (#693)
Wave 5.4 Discovery: Complete README & Mermaid Diagram Audit (#667) (#687
feat(#668): Add Mermaid diagram syntax validation (#693)
ashleyshaw commentedon Jun 1, 2026
Admin note (2026-06-01): intended delivery for this workstream is PR #723 into . PR #703 was merged to by mistake and was reverted by PR #726.
ashleyshaw commentedon Jun 1, 2026
Correction: this workstream should reference PR #723 on develop as canonical. PR #703 hit main accidentally and was reverted by PR #726.
github-actions commentedon Jun 19, 2026
Missing required section(s): Definition of Ready (DoR), Definition of Done (DoD)
The issue will remain open and flagged until the body is corrected.
Please update the issue with one of the official templates:
If this was opened by automation, update the automation to preserve the template sections before creating the issue.