Skip to content

docs: repository - Correct inherited branding and testing guidance #453

Open

Description

@ashleyshaw

Documentation Update Summary

Correct verified inherited makeup-site branding and inaccurate testing guidance in lightspeedwp/ThisOneTimeOnAcidCom so contributors receive accurate context for thisonetimeonacid.com.

A complete static review of tests/ at develop revision 6b3b76baa955acdfaee0d5e4aef39e099b4b083e covered nine files, 66,713 bytes and 1,588 lines. The directory contains no documentation files and no direct ashshaw.makeup references. Preserve meaningful tests rather than deleting them as inherited documentation.

Linked Stories/Tasks/PRs/Epic

Coordinate without duplicating or changing existing work:

No epic, native relationship or new PR association is proposed.

Milestones & Timeline

No milestone, release commitment or deadline requested.

What documentation is needed?

Review and correct the verified passages in:

  • CONTRIBUTING.md
  • guidelines/README.md
  • guidelines/Guidelines.md
  • guidelines/changelog.md
  • docs/TESTING.md
  • Directly relevant testing/configuration guidance in AGENTS.md
  • Directly relevant testing guidance in README.md

Replace inherited product descriptions with accurate book-site context. Reconcile documented commands, runner discovery, prerequisites, root e2e/ placement and historical test-result claims with committed configuration.

The attached review records all nine test files, proposed dispositions, supporting evidence and limitations. Test-harness defects are coordination findings, not automatically authorised implementation.

Why is this documentation important?

Inherited branding gives contributors the wrong product context. Contradictory testing instructions can lead to misplaced tests and misleading assumptions about what default commands verify.

Cleanup must preserve applicable reusable guidance, meaningful assertions, legitimate author references, required asset schema fields, protected images and historical changelog content.

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
  • Verified inherited project descriptions are rewritten for thisonetimeonacid.com without removing legitimate author or historical information.
  • Testing guidance matches committed runner configuration, prerequisites and actual test locations; suites omitted by npm test are identified explicitly.
  • Historical results retain their dates/revisions and are not presented as fresh execution evidence.
  • The nine-file test inventory and keep/rewrite/conditional-retirement recommendations remain available as context.
  • Any deletion proposal identifies exact paths, incoming references, preserved requirements and replacement/retirement rationale, and receives explicit approval before deletion.
  • Relevant links and approved documentation changes are verified; only checks actually executed are reported as executed.
  • Runtime fixes, harness changes, dependency installation, component consolidation, asset retirement, locked configuration, centrally managed workflows and hosting changes remain outside scope unless separately approved.

Additional Context

Repository: lightspeedwp/ThisOneTimeOnAcidCom.

Reviewed scope: tests at the reviewed revision, plus specifically identified supporting documentation.

Attach toa-tests-cleanup-review-2026-10-24.md after approval. This report is static evidence, not proof that tests pass.

toa-tests-cleanup-review-2026-10-24.md

No unconditional deletion is proposed. Implementation ownership and authorised test execution remain unresolved.

Template conflict: the live template combines meta:no-changelog with mandatory changelog wording. That label is not proposed. Preserve protected history and resolve the applicable repository requirement before implementation. Template checklist items do not authorise PR creation, merging, branch deletion or updates to other records.


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 PR template based on type:docs PR label or linked issue type or linked issue type:docs label
  • Branch deleted after merge
  • Linked issue(s) updated with latest status and closed after merge,
  • The related epic should not be closed, instead updated with a comment to reflect the closed issue

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

Type

No type

Fields

Priority

Medium

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions