Skip to content

audit: readme - Verify coverage and document refresh findings #545

Open

Description

@ashleyshaw

Audit Summary

Audit README coverage in lightspeedwp/ThisOneTimeOnAcidCom and produce the evidence needed to agree refresh boundaries.

Use the earlier inventory of 20 READMEs at revision 0423fb8b935235c61defe6324251e0205ca9372d as historical baseline evidence—not a current count or completed audit.

Code Review Summary

Read-only documentation assessment. No repository edits, installations, builds or Spec Kit execution are authorised by issue creation.

Linked Stories/Tasks/PRs/Epic

This issue performs the audit coordinated by its parent epic. Use the epic’s existing overlap register; preserve work already owned elsewhere.

No new dependency links are proposed. The epic’s existing blocking relationships remain unchanged.

Milestones & Timeline

No deadline or estimate proposed. Complete the findings and scope handoff before affected README implementation begins.

Audit Checklist / Scope

  • Reconcile every tracked README against the baseline inventory
  • Read each README semantically, not only structurally
  • Confirm suspected fence, heading, link and fragment defects
  • Compare commands, paths and operational claims with committed sources
  • Distinguish current instructions from historical reports and planned functionality
  • Identify overlap and protected-file requirements
  • Record edit, retain unchanged or blocked dispositions
  • Recommend whether additional Spec Kit planning is necessary

Findings / Risks

Earlier findings include 16 suspected fence defects, contradictory setup guidance, incorrect paths and unsupported readiness claims. Confirm these against the audited revision before reporting them as current defects.

Protected guideline changes and the recorded manifest conflict are not remediation work for this issue.

Remediation Actions

Record a coverage ledger in the issue containing:

  • Path and purpose
  • Reviewed revision and source evidence
  • Confirmed finding and impact
  • Recommended correction or unchanged disposition
  • Existing ownership, approval requirement and verification method

Map residual corrections to existing implementation work. Do not create additional issues or repository artefacts automatically.

Acceptance Criteria

  • Every current README and inventory delta is accounted for
  • Confirmed findings include evidence and practical recommendations
  • Suspected, historical and current findings are clearly distinguished
  • Overlap decisions prevent duplicate implementation
  • Protected or unresolved work has an explicit blocked disposition
  • The epic receives a review-ready findings and scope handoff

Additional Context

No branch or repository file changes are proposed. Missing ownership or approval remains explicit rather than inferred.

Definition of Ready

  • Repository, baseline and audit scope identified
  • Existing overlap register available

Definition of Done

  • Coverage ledger completed
  • Findings and recommended dispositions documented
  • Scope decisions and unresolved questions handed to the epic
  • No implementation completion or epic closure implied
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Type

No type

Fields

Priority

None yet

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions