Skip to content

docs(a11y): add accTitle/accDescr to all Mermaid diagrams — Wave 3B (#513)#526

Merged
ashleyshaw merged 4 commits into
developfrom
feat/513-wave-3b-readme-mermaid-repair
May 28, 2026
Merged

docs(a11y): add accTitle/accDescr to all Mermaid diagrams — Wave 3B (#513)#526
ashleyshaw merged 4 commits into
developfrom
feat/513-wave-3b-readme-mermaid-repair

Conversation

@ashleyshaw
Copy link
Copy Markdown
Member

Summary

  • Adds accTitle and accDescr WCAG 2.2 AA accessibility attributes to all 15 Mermaid diagrams across 8 README files that were missing them
  • WCAG 2.2 AA compliance for Mermaid diagrams: 21% → 100% (root README.md was already compliant; 8 other files repaired)
  • Publishes Wave 3A/3B combined audit report, findings CSV, and repair log to .github/reports/mermaid-audit/
  • No diagram content changed — all edits are additive (accessibility attributes only)
  • No syntax errors found in any of the 15 diagrams

Files changed

File Diagrams repaired
.github/README.md 4
profile/README.md 4
scripts/README.md 3
tests/README.md 3
scripts/validation/README.md 1
.github/ISSUE_TEMPLATE/README.md 1
.github/projects/README.md 1
.vscode/README.md 1
Total 15

Deliverables

  • .github/reports/mermaid-audit/audit-report-2026-05-28.md — full audit with per-file inventory and compliance summary
  • .github/reports/mermaid-audit/findings.csv — machine-readable findings inventory for Wave 3C tooling
  • .github/reports/mermaid-audit/repair-report-2026-05-28.md — line-by-line repair log

Acceptance criteria

  • All Mermaid diagrams in README files have accTitle and accDescr attributes
  • No syntax errors introduced
  • Audit report published to .github/reports/mermaid-audit/
  • Findings CSV ready for Wave 3C tooling integration
  • CHANGELOG updated with PR and issue links
  • Execution plan updated to reflect Wave 3B in progress

Dependencies

  • Closes #513 — Wave 3B: README & Mermaid Diagram Repair & Update
  • Unblocks #514 — Wave 3C: Workflow & Agent Coordination Setup

Test plan

  • Confirm grep -r 'accTitle' . --include="README.md" | grep -v node_modules returns entries for all 8 repaired files
  • Confirm no accTitle was removed from README.md (root)
  • CI linting passes on all modified Markdown files
  • Audit report renders correctly in GitHub Markdown preview

https://claude.ai/code/session_01Ukh7BPcSJQcr3zwA6QqqCV


Generated by Claude Code

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 28, 2026

Warning

Review limit reached

@ashleyshaw, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 7 minutes and 54 seconds. Learn how PR review limits work.

Your organization has run out of usage credits. Purchase more in the billing tab.

⌛ How to resolve this issue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available.

Please see our Fair Usage Limits Policy for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Repository YAML (base), Organization UI (inherited)

Review profile: CHILL

Plan: Pro

Run ID: 6c4fd899-6a38-40f6-bbe7-27ccf570357a

📥 Commits

Reviewing files that changed from the base of the PR and between 378c4d7 and 7cde6f1.

⛔ Files ignored due to path filters (1)
  • .github/reports/mermaid-audit/findings.csv is excluded by !**/*.csv
📒 Files selected for processing (4)
  • .github/reports/mermaid-audit/audit-report-2026-05-28.md
  • .github/reports/mermaid-audit/repair-report-2026-05-28.md
  • CHANGELOG.md
  • README.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feat/513-wave-3b-readme-mermaid-repair

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request adds accTitle and accDescr accessibility attributes to 15 Mermaid diagrams across 8 README files to achieve 100% WCAG 2.2 AA compliance, and introduces a comprehensive audit report, findings CSV, and repair report under .github/reports/mermaid-audit/. Feedback on these changes highlights a structural mismatch in .github/projects/README.md where the diagram and metadata describe the reports directory instead of the projects directory. Additionally, several relative links to instruction files in the newly added audit and repair reports are incorrect and need to be adjusted to resolve properly.

Comment thread .github/projects/README.md Outdated
Comment on lines +43 to +49
accTitle: "Reports Directory Structure"
accDescr {
Tree diagram showing the .github/reports directory branching into sixteen
subdirectories: agents, analysis, audits, coverage, frontmatter, implementation,
issue metrics, labeling, linting, meta, metrics, migration, optimisation,
tech-debt, and validation.
}
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The accessibility title and description added here refer to the "Reports Directory Structure" and .github/reports directory. However, this file is .github/projects/README.md.

There appears to be a copy-paste or structural mismatch in this file, as the entire section and Mermaid diagram describe the reports directory structure instead of the projects directory structure. Please update the diagram and metadata to correctly reflect the projects directory structure (e.g., active/, completed/, planning/, ADR/).

Comment on lines +231 to +233
- [Mermaid Instructions](../../../instructions/mermaid.instructions.md)
- [Markdown Instructions](.././../instructions/markdown.instructions.md)
- [Accessibility Instructions](../../../instructions/a11y.instructions.md)
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The relative paths to the instruction files are incorrect or inconsistent.

Since this report is located at .github/reports/mermaid-audit/audit-report-2026-05-28.md (3 levels deep), going up 2 levels (../../) brings you to .github/, where the canonical instructions/ directory resides.

  • ../../../instructions/mermaid.instructions.md goes up 3 levels to the repository root, pointing to a non-existent or non-canonical root-level path.
  • .././../instructions/markdown.instructions.md contains a redundant . segment.

Correcting these to use ../../instructions/ ensures the links resolve correctly to .github/instructions/.

Suggested change
- [Mermaid Instructions](../../../instructions/mermaid.instructions.md)
- [Markdown Instructions](.././../instructions/markdown.instructions.md)
- [Accessibility Instructions](../../../instructions/a11y.instructions.md)
- [Mermaid Instructions](../../instructions/mermaid.instructions.md)
- [Markdown Instructions](../../instructions/markdown.instructions.md)
- [Accessibility Instructions](../../instructions/a11y.instructions.md)


## References

- [Mermaid Instructions](../../../instructions/mermaid.instructions.md)
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The relative path to the Mermaid instructions file is incorrect.

Since this report is located at .github/reports/mermaid-audit/repair-report-2026-05-28.md (3 levels deep), going up 2 levels (../../) brings you to .github/, where the canonical instructions/ directory resides.

../../../instructions/mermaid.instructions.md goes up 3 levels to the repository root, pointing to a non-existent or non-canonical root-level path. Correcting it to ../../instructions/mermaid.instructions.md ensures the link resolves correctly.

Suggested change
- [Mermaid Instructions](../../../instructions/mermaid.instructions.md)
- [Mermaid Instructions](../../instructions/mermaid.instructions.md)

@ashleyshaw ashleyshaw force-pushed the feat/513-wave-3b-readme-mermaid-repair branch from 948ed44 to 1236d4a Compare May 28, 2026 15:41
@github-actions github-actions Bot added status:needs-review Awaiting code review type:feature Feature or enhancement priority:normal Default priority area:documentation Docs & guides area:tests Test suites & harnesses area:scripts Scripts & tooling labels May 28, 2026
@github-actions
Copy link
Copy Markdown
Contributor

🔍 Reviewer Summary for PR #526

CI Status:success
Files changed: 13

Recommendations

  • Ready to proceed pending human review

@github-actions github-actions Bot added lang:md Markdown content/docs type:chore Chore / small hygiene change type:documentation Documentation meta:needs-changelog Requires a changelog entry before merge and removed type:documentation Documentation type:chore Chore / small hygiene change labels May 28, 2026
@github-actions
Copy link
Copy Markdown
Contributor

🔍 Reviewer Summary for PR #526

CI Status:success
Files changed: 14

Recommendations

  • Ready to proceed pending human review

@ashleyshaw ashleyshaw marked this pull request as ready for review May 28, 2026 15:55
@chatgpt-codex-connector
Copy link
Copy Markdown

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.

@github-actions
Copy link
Copy Markdown
Contributor

🔍 Reviewer Summary for PR #526

CI Status:success
Files changed: 14

Recommendations

  • Ready to proceed pending human review

@ashleyshaw ashleyshaw force-pushed the feat/513-wave-3b-readme-mermaid-repair branch from 4966ab1 to b319fc8 Compare May 28, 2026 16:43
@github-actions
Copy link
Copy Markdown
Contributor

🔍 Reviewer Summary for PR #526

CI Status:success
Files changed: 14

Recommendations

  • Ready to proceed pending human review

1 similar comment
@github-actions
Copy link
Copy Markdown
Contributor

🔍 Reviewer Summary for PR #526

CI Status:success
Files changed: 14

Recommendations

  • Ready to proceed pending human review

claude added 2 commits May 28, 2026 18:51
)

Adds missing WCAG 2.2 AA accessibility attributes to all 15 Mermaid
diagrams across 8 README files, bringing compliance from 21% to 100%.
Publishes Wave 3A/3B audit report, findings CSV, and repair log to
.github/reports/mermaid-audit/. No diagram content was changed.

https://claude.ai/code/session_01Ukh7BPcSJQcr3zwA6QqqCV
Fixes broken absolute GitHub blob URLs in .github/README.md: migrates
coding-standards path from .github/instructions/ to root instructions/,
consolidates four deleted block-theme/ links to plugin-structure.instructions.md,
and corrects PULL_REQUEST_TEMPLATE.md case to lowercase. Fixes stale relative
links in Development Standards section. Removes two auto-generated duplicate
footer blocks with stale lsx-demo-theme links. Fixes broken relative link in
scripts/README.md (TEST_COVERAGE_SUMMARY.md → README.md). Adds .lycheeignore
to exclude Twitter/X and LinkedIn from lychee checks (both block automated
HTTP clients).

https://claude.ai/code/session_01Ukh7BPcSJQcr3zwA6QqqCV
@ashleyshaw ashleyshaw force-pushed the feat/513-wave-3b-readme-mermaid-repair branch from d5d93c5 to b00391a Compare May 28, 2026 16:53
@github-actions
Copy link
Copy Markdown
Contributor

🔍 Reviewer Summary for PR #526

CI Status:success
Files changed: 14

Recommendations

  • Ready to proceed pending human review

@ashleyshaw ashleyshaw force-pushed the feat/513-wave-3b-readme-mermaid-repair branch from b00391a to b9efba7 Compare May 28, 2026 16:54
@github-actions
Copy link
Copy Markdown
Contributor

🔍 Reviewer Summary for PR #526

CI Status:success
Files changed: 15

Recommendations

  • Ready to proceed pending human review

@ashleyshaw ashleyshaw force-pushed the feat/513-wave-3b-readme-mermaid-repair branch from cf34529 to 7cde6f1 Compare May 28, 2026 16:58
@ashleyshaw ashleyshaw merged commit 05b0315 into develop May 28, 2026
6 checks passed
@ashleyshaw ashleyshaw deleted the feat/513-wave-3b-readme-mermaid-repair branch May 28, 2026 16:58
@github-actions
Copy link
Copy Markdown
Contributor

🔍 Reviewer Summary for PR #526

CI Status:success
Files changed: 5

Recommendations

  • Ready to proceed pending human review

1 similar comment
@github-actions
Copy link
Copy Markdown
Contributor

🔍 Reviewer Summary for PR #526

CI Status:success
Files changed: 5

Recommendations

  • Ready to proceed pending human review

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

Labels

area:documentation Docs & guides area:scripts Scripts & tooling area:tests Test suites & harnesses lang:md Markdown content/docs meta:needs-changelog Requires a changelog entry before merge priority:normal Default priority status:needs-review Awaiting code review type:feature Feature or enhancement

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Wave 3B: README & Mermaid Diagram Repair & Update

2 participants