Skip to content

[Child] Audit: Validate Mermaid Syntax in All Diagrams #922

Open

Description

@ashleyshaw

Parent Issue: #905

Overview

Validate Mermaid syntax in all in-scope README diagrams.

In-Scope

  • Mermaid code blocks in README files

Audit Checklist

  • Mermaid blocks extracted
  • Syntax validated
  • Parse/render failures documented with fix hints

Deliverables

  • Mermaid syntax validation report

Related Files

  • README files containing Mermaid diagrams

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

Activity

  1. linear-code commented on Jun 8, 2026

    @linear-code
  2. github-actions commented on Jun 17, 2026

    @github-actions
    Contributor

    ⚠️ This issue does not follow a required issue template.

    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.

  3. ashleyshaw commented on Jun 18, 2026

    @ashleyshaw
    MemberAuthor

    Reopened — incorrectly closed by the template-enforcement bot (missing DoR/DoD sections).

    Status: Work already completed.
    Mermaid syntax validation was performed in #668. PR #977 added npm run validate:mermaid-syntax as a permanent CI gate (validate-mermaid-pr.yml), so all future diagram changes are automatically validated. Closing as completed.


    Generated by Claude Code

  4. added this to the v1.2 milestone on Jul 22, 2026
  5. github-actions commented on Sep 8, 2026

    @github-actions
    Contributor

    ⚠️ Bare Labels Detected

    This issue has labels that are not in the canonical taxonomy:

    • migrate:priority:normal
    • migrate:type:audit
    • migrate:area:documentation

    Valid Canonical Labels

    Please use labels with a prefix from the canonical taxonomy:

    • Type: type:bug, type:feature, type:task, type:documentation, etc.
    • Status: status:needs-triage, status:in-progress, status:done, etc.
    • Priority: priority:critical, priority:high, priority:normal, priority:low
    • Area: area:ci, area:docs, area:labels, area:security, etc.
    • Meta: meta:needs-changelog, meta:duplicate, meta:blocked, etc.

    For the complete list, see .github/labels.yml.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Type

Fields

Priority

None yet

Projects

No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions