Repository navigation
Description
Documentation Update Summary
Correct confirmed residual rendering, navigation and instructional defects in the agreed nested README inventory for lightspeedwp/ThisOneTimeOnAcidCom.
Retain accurate files unchanged and preserve historical findings, attribution and existing ownership. Issue creation does not authorise implementation.
Linked Stories/Tasks/PRs/Epic
Parent: #531. Blocked by the proposed coverage audit; blocks the proposed final validation child.
Use the overlap register to agree passage-level boundaries. Existing issues are coordination references, not blanket blockers awaiting their complete delivery.
Milestones & Timeline
No deadline, milestone or estimate proposed. Follow the audit and coordinate shared-branch edits with the root README child.
What documentation is needed?
For each approved path, correct confirmed fences, links, fragments, examples and operational claims against source evidence.
Review actual hook behaviour, configured versus executable Spec Kit support, asset availability, historical report framing and current versus planned behaviour.
Do not rewrite skills, prompts, policy, journal schemas, report findings or task trackers under README formatting scope.
Why is this documentation important?
Directory entry points must accurately explain their contents and usage without asserting nonexistent assets, unverified automation or completed functionality.
Acceptance Criteria
- Documentation is clear, accurate, and up-to-date
- Includes code examples/screenshots if applicable
- Documentation is accessible and easy to find
- Changelog entry prepared for PR if user-facing update
- PR uses correct branch prefix (
docs/) - PR description updated with relevant details
- Changelog entry prepared for PR (if applicable)
- Labels/types match org standards
- Every nested README has an edit, retain unchanged or blocked disposition
- Confirmed rendering and local-link defects are corrected or explicitly blocked
- Instructions and operational claims match identified sources
- Historical findings retain their context and limitations
- Protected and overlapping work is not implemented twice
- README changes do not imply feature or tracker completion
Additional Context
The baseline contains 19 nested READMEs. Reconcile the current inventory before implementation.
Protected guidelines/README.md and guidelines/responsive/README.md are coverage-only here; no edits are proposed through this child.
The separately proposed .github/README.md is excluded. No changelog edit is proposed.
Branch instructions
- Repository:
lightspeedwp/ThisOneTimeOnAcidCom. - Proposed shared branch:
docs/readme-repository-refresh, fromdevelop; not created. - No additional child branch proposed. Coordinate implementation to avoid conflicting shared-branch edits.
- Recheck repository instructions, current revision, branch/PR overlap and branch validator before separately approved implementation.
- Use the shared documentation PR template,
.github/PULL_REQUEST_TEMPLATE/pr_docs.md. - These children are implementing work; the parent is coordination context, not a PR closing target.
- No closing association is proposed before verified implementation/GitHub mapping.
- No direct edits on protected branches, protected-file changes, force-push, merge, deployment or automatic closure.
- Stop for revised approval before expanding files or operations.
Expected file changes
Conditional Edit of these existing paths, only for confirmed residual corrections:
.agents/README.md
.codex/README.md
.claude/cloud/README.md
.claude/hooks/README.md
.github/DISCUSSION_TEMPLATE/README.md
.github/reports/README.md
.github/reports/toa-media-library/README.md
.github/specs/001-repo-governance-layout-and-agentic-workflows/phases/README.md
content/journal/README.md
prompts/README.md
reports/contrast-audit/README.md
reports/theme-styling-audit/README.md
src/app/data/README.md
src/app/public/fonts/README.md
src/app/public/pwa-icons/README.md
src/styles/blocks/README.md
tasks/README.md
Path evidence: parent inventory at 0423fb8b935235c61defe6324251e0205ca9372d; confirm before editing. No Create, Move or Delete operations proposed. Source, configuration, assets, manuscript, specification/state creation and manifest repair are excluded.
Definition of Ready (DoR)
- Documentation need is clear and well-defined
- Related docs/issues or files linked
- Acceptance criteria listed
- Estimate added if relevant
- Milestone/release assigned (if applicable)
Definition of Done (DoD)
- Documentation meets org standards and guidelines
- Changelog entry prepared for PR (
CHANGELOG.md) - Documentation reviewed for clarity and accessibility
- Screenshots/code examples included if relevant
- PR uses correct branch prefix (
docs/) - PR uses the correct documentation template
- Branch deleted after merge
- Linked implementing issues updated and closed after merge
- Related epic remains open and receives an appropriate update
Lifecycle criteria require applicability decisions. They do not authorise deleting the shared branch, closing records or updating the parent.
Metadata
Metadata
Assignees
Labels
Type
Fields
Priority
Activity
linear-code commentedon Oct 26, 2026
TOA-416