Skip to content

[Child of #652] Audit: Discover All 44 README.md Files - Inventory #667

@ashleyshaw

Description

@ashleyshaw

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

  • Find all README.md files in repo
  • Create spreadsheet with columns: Path | Size | Last Updated | Has Mermaid | Issues Found
  • Categorize each README by folder type
  • Check for broken links in each README
  • Check for outdated content indicators
  • Note presence and count of Mermaid diagrams
  • Document any immediate issues found

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

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