Skip to content

[Audit] 44 README Files - Mermaid Diagrams & Accessibility Review #652

@ashleyshaw

Description

@ashleyshaw

Overview

Comprehensive audit of 44 README.md files across the repository to verify Mermaid diagram syntax, accessibility compliance, and content freshness.

Current Problems

  1. Mermaid diagrams may have syntax errors or be outdated
  2. Diagrams may lack accessibility attributes (accTitle, accDescr)
  3. Diagrams may not work in light/dark mode
  4. README content may be outdated or incomplete
  5. No systematic way to verify diagram accessibility compliance

Areas to Audit

See child issues for detailed audits of:

  • Root & core README files (6 files)
  • Feature folder README files (12 files)
  • Sub-folder README files (20 files)
  • Test/config README files (6 files)
  • Mermaid diagram syntax validation
  • Accessibility compliance (WCAG AA)
  • Light/dark mode rendering

Acceptance Criteria

  • All 44 README files inventoried
  • Mermaid diagram syntax validated
  • Accessibility attributes added where needed
  • Content freshness verified and updated
  • Audit report generated

Related Files

All README.md files across the repository (see audit report for inventory)

Related Issues

Related Documentation

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Priority

    None yet

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions