Repository navigation
Description
Documentation Update Summary
Refresh README.md in lightspeedwp/ThisOneTimeOnAcidCom as an accurate contributor entry point for the book and companion website. Implement only confirmed residual corrections agreed by the coverage audit.
Issue creation does not authorise repository implementation.
Linked Stories/Tasks/PRs/Epic
Parent: #531. Blocked by the proposed coverage audit; blocks the proposed final validation child.
Coordinate branding/testing, tooling and structure passages with the existing work in the overlap register. Do not duplicate those implementations.
Milestones & Timeline
No deadline, milestone or estimate proposed. Begin after the audit establishes permitted passages and approval requirements.
What documentation is needed?
Edit only root README.md:
- Explain the book-first purpose and distinguish manuscript from website.
- Provide verified prerequisites, canonical installation and local development instructions.
- Document actual package commands and relevant side effects.
- Correct directory, route and data README references.
- Link to authoritative contribution, governance and agent guidance rather than duplicating it.
- Repair confirmed rendering defects.
- Separate historical reports from current instructions.
- Remove or qualify unsupported completion, testing, deployment, PWA and accessibility claims.
Preserve accurate material; avoid cosmetic-only changes.
Why is this documentation important?
Contributors need reliable setup and navigation without nonexistent paths, contradictory instructions or unsupported readiness claims.
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
- Setup commands, versions, paths and routes match identified committed sources
- Confirmed rendering and local-link defects are corrected or explicitly blocked
- Current instructions are distinguished from historical evidence
- Existing-work boundaries are respected
- Remaining limitations are explicit
Additional Context
Use the parent’s earlier scan as baseline evidence, not a fresh verification result. Recheck the implementation revision.
No CHANGELOG.md edit is proposed. Resolve the template’s changelog contradiction before implementation.
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
Edit README.md only, for the approved corrections described above.
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-415