Overview
Discover, inventory, and audit all README.md files across the repository to create a comprehensive baseline for subsequent audits and improvements.
Scope
- Use script or manual inspection to find all README.md files
- Create inventory spreadsheet with metadata for each
- Categorize by: Root/Core, Feature folders, Sub-folders, Test/Config
- Check each README for broken links, outdated content
- Identify which ones have Mermaid diagrams
- Note file sizes and last update dates
Audit Checklist
Deliverables
- Complete README inventory spreadsheet/CSV
- List of READMEs by category (with counts)
- Initial issues log (broken links, outdated content)
- Mermaid diagram inventory (which READMEs have diagrams, how many)
Related Files
- All README.md files across repository
.github/ folder and subfolders
docs/ folder and subfolders
agents/, scripts/, workflows/, instructions/ folders
Related Documentation
Overview
Discover, inventory, and audit all README.md files across the repository to create a comprehensive baseline for subsequent audits and improvements.
Scope
Audit Checklist
Deliverables
Related Files
.github/folder and subfoldersdocs/folder and subfoldersagents/,scripts/,workflows/,instructions/foldersRelated Documentation