Repository navigation
[Child of #652] Update: Fix & Refresh 44 README Files with Current Information #670
Description
Overview
Implementation phase: Update all 44 README files with current information, fix syntax errors, add/update Mermaid diagrams with accessibility attributes, and ensure consistent formatting.
Scope
This is the implementation phase following audits from child issues 4.1-4.3:
- Update outdated content based on audit findings
- Fix broken links identified in audits
- Add/update Mermaid diagrams with proper accessibility attributes
- Ensure diagrams render correctly in light/dark mode
- Apply consistent formatting across all READMEs
Checklist
- Review findings from audit child issues
- Update each README with current folder/file purpose
- Fix all broken links identified in audits
- Add
accTitleandaccDescrto all Mermaid diagrams - Test all diagrams in light and dark mode
- Verify color contrast meets WCAG AA
- Apply consistent README structure/formatting
- Verify all cross-references are correct
Deliverables
- All 44 README.md files updated
- Repair report documenting all changes
- Verification report: all links working, diagrams accessible
- Before/after comparison (key changes)
Related Files
All 44 README.md files across the repository
Related Issues
- Child 4.1 — Discover & Audit READMEs
- Child 4.2 — Validate Mermaid Syntax
- Child 4.3 — Accessibility Compliance
- #512 — Wave 3A Discovery & Audit
- #513 — Wave 3B Repair & Update
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-844
LS-1146
Fix markdown linting errors - add blank lines around headings and lists
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
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)
fix(#670): Correct Mermaid accDescr syntax in README.md diagrams (4 d…
fix(#670): Add accessibility attributes to 4 Mermaid diagrams in .git…
fix(#670): Shorten Mermaid accDescr values to prevent line length issues
fix(#670): Add missing frontmatter to implementation plan
18 remaining items
Merge pull request #726 from lightspeedwp/revert-703-phase-3-plugin-r…
ashleyshaw commentedon Jun 1, 2026
PR reference correction (2026-06-01):\n\n- Intended landing branch: via PR #723 (merged).\n- Accidental merge to : PR #703.\n- Revert on : PR #726 (merged).\n\nCurrent status: work is present in and reverted from .
ashleyshaw commentedon Jun 1, 2026
Correction: intended landing branch was develop via PR #723 (merged). PR #703 was accidentally merged to main, then reverted by PR #726 (merged). Current state is correct: in develop, reverted from main.
Merge pull request #699 from lightspeedwp/claude/wave-5-4-readme-fixes
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.
github-actions commentedon Sep 8, 2026
This issue has labels that are not in the canonical taxonomy:
migrate:priority:normalmigrate:type:taskmigrate:area:documentationValid Canonical Labels
Please use labels with a prefix from the canonical taxonomy:
type:bug,type:feature,type:task,type:documentation, etc.status:needs-triage,status:in-progress,status:done, etc.priority:critical,priority:high,priority:normal,priority:lowarea:ci,area:docs,area:labels,area:security, etc.meta:needs-changelog,meta:duplicate,meta:blocked, etc.For the complete list, see .github/labels.yml.