Skip to content

docs: repository - Remove obsolete guidance and documents - #481

Merged
mergify[bot] merged 1 commit into
developfrom
docs/repository-legacy-cleanup
Oct 25, 2026
Merged

mergify[bot] merged 1 commit into
developfrom
docs/repository-legacy-cleanup

Conversation

@ashleyshaw

@ashleyshaw ashleyshaw commented Oct 24, 2026 •

Copy link
Copy Markdown
Member

Documentation Pull Request

Linked issues

Relates to #448 (TOA-366). This is a bounded contribution; the wider documentation outcome remains open. No parent epic or closing target is proposed.

What changed

  • Replace docs/ebook-preferences.md, docs/TESTING.md, docs/dark-mode-troubleshooting.md, docs/NETLIFY_CACHE_VERIFICATION.md and docs/INTEGRATION-VALIDATION-PLAN.md with the exact owner-approved uploads. The updated testing attachment retains the original review provenance, adds the native-test row naming both files, and describes unit → native → build → E2E.
  • Delete the approved duplicate docs/figma-ai-brief-1.md and obsolete docs/makeup-kit-essentials.md; preserve the canonical brief.
  • Remove only the five-line unrelated search-result fragment and two-line image3 definition from docs/pending-questions.md; preserve every other byte, including image1 and image2.

Audience & placement

  • Audience: contributors and maintainers.
  • Location: exactly eight approved paths under docs/.

Preview / Screenshots

Documentation-only diff; no UI screenshots. No runtime, storage, stylesheet, test, dependency, hosting, header or workflow changes. The historical PR-426 validation record is unchanged.

Notes

  • Base: freshly fetched develop, f99275b085cffd209b9bd42f6e463c0af643099a.
  • Original review revision: 3f583002482d80ffd1910676bcf7c63e13989b20. Intervening Sentry changes were inspected; the owner approved the testing command-sequence amendment. Other inspected contracts still support the drafts.
  • Owner-selected template: lightspeedwp/.github/.github/PULL_REQUEST_TEMPLATE/pr_docs.md; owner-selected type label: type:docs. The existing local router suggests pr_documentation.md and attempts type:documentation; no routing or governance repair is included.
  • Head commit: 5607ce8077f8cbb5541fc116c69b8b14d065139f (Node 24.19.0, npm 11.9.0).
  • Executed checks against the base above:
    • git fetch origin develop: exit 0.
    • npm run validate:branch-name -- --branch docs/repository-legacy-cleanup: exit 0 before creation.
    • npm run validate:branch-name: exit 0 after creation.
    • python /tmp/toa-366/verify.py: exit 0; all five uploads match byte-for-byte, exactly eight paths changed, replacement fences balanced, inline local link targets exist, precise removal verified, retained material unchanged, and no tracked deletion references found.
    • Initial npm run build: exit 1 because the existing installation lacked @sentry/vite-plugin.
    • Owner-authorised npm ci: exit 0; manifest and lockfile unchanged; postinstall installed Lefthook hooks.
    • Subsequent npm run build: exit 0; chunk-size warning retained.
    • git commit: exit 0; pre-commit branch validation passed; journal validation skipped because no journal files changed.
    • git push -u origin docs/repository-legacy-cleanup: exit 0; pre-push destination-branch validation and build both passed. No hooks bypassed.
    • git diff --check: exit 2; the pre-existing blank line following the removed image3 definition becomes a trailing blank line. It remains intact to preserve the exact authorised deletion scope.
  • Not run: Markdown lint (no installed CLI), unit/native/build-test/E2E suites, browser/accessibility/performance checks, deployment checker, live forms, external link requests or deployment. Static source inspection is not an executed browser or deployment test.
  • Historical worktree state was reported clean after commit and push. GitHub records this PR as merged on 25 October 2026 at 01:18:22 UTC. Live GitHub results at head 5607ce8077f8cbb5541fc116c69b8b14d065139f show successful relevant checks and preview statuses, with other checks skipped or neutral and cancelled superseded runs. Jest was skipped for this documentation-only contribution. No production deployment, publication or whole-issue acceptance is verified by this update.
  • The completed contribution is limited to the eight approved paths, not the wider documentation audit.

Changelog

Issue #448 has meta:no-changelog; CONTRIBUTING.md explicitly exempts it. The protected root changelog is unchanged; no workaround labels are requested.

Added

No runtime features.

Changed

Five approved documentation replacements; precise pending-questions cleanup.

Fixed

Source-contract and historical-evidence descriptions in the bounded documents.

Removed

Two approved documents and the unrelated embedded fragment/image3 only.


Checklist (Global DoD / PR)

  • All AC met and demonstrated — wider issue acceptance criteria remain outstanding.
  • Tests added/updated (unit/E2E as appropriate) — not applicable to this documentation-only contribution.
  • Accessibility checklist completed (where relevant) — no browser accessibility result claimed.
  • Docs/readme/changelog updated (if user-facing) — approved docs updated; changelog exemption applies.
  • Security scope inspected: no secrets or sensitive data introduced; unrelated fragment/image3 removed without reproducing their contents.
  • Code/design reviews approved — automated review completed; no approving review is recorded.
  • CI green; linked issues closed; release notes prepared (if shipping) — relevant checks report success, while other checks were skipped or neutral; Jest did not run. The wider issue remains open, and shipping acceptance is not established.

Summary by CodeRabbit

  • Documentation
    • Updated integration, deployment, testing and troubleshooting guides to distinguish documented procedures and historical reports from checks actually completed. They now provide clearer verification steps, evidence requirements and limits on what can be concluded.
    • Expanded ebook-preference guidance with storage defaults, fallback behaviour and details of how reader settings are applied.
    • Removed the Figma design brief, makeup-kit guide and two entries from the pending-questions document.

@vercel

vercel Bot commented Oct 24, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
thisonetimeonacidcom Ready Ready Preview Oct 24, 2026 4:42pm UTC

@netlify

netlify Bot commented Oct 24, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for thisonetimeonacid ready!

Name Link
🔨 Latest commit 5607ce8
🔍 Latest deploy log https://app.netlify.com/projects/thisonetimeonacid/deploys/6adcdfccb6aa5a0945e70157
😎 Deploy Preview https://deploy-preview-481--thisonetimeonacid.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

@github-actions

Copy link
Copy Markdown

PR Template Routing 📋

Branch prefix: docs

Suggested template: pr_documentation.md

Type: Documentation PR


Canonical templates are managed in lightspeedwp/.github:

  • Review the suggested template to ensure your PR description covers the required sections
  • All PR templates route from the central .github repository

@coderabbitai

coderabbitai Bot commented Oct 24, 2026 •

Copy link
Copy Markdown
Contributor
Pre-merge checks: Passed 5
Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Title check Passed The title clearly identifies a documentation cleanup that removes obsolete guidance and documents. It is concise and related to the main changes, although it does not mention the replacement of approv…
Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (5 skipped: 5 unsupported.)

Full details: Title check

Explanation

The title clearly identifies a documentation cleanup that removes obsolete guidance and documents. It is concise and related to the main changes, although it does not mention the replacement of approved documents.

  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Comment @coderabbitai help to get the list of available commands.

@github-actions

Copy link
Copy Markdown

Drift Detection ✅

✅ No drift detected. Configuration is canonical.

Canonical governance files are correctly centralized in lightspeedwp/.github.

@ashleyshaw ashleyshaw self-assigned this Oct 24, 2026
@ashleyshaw
ashleyshaw marked this pull request as ready for review October 24, 2026 16:44
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 24, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-10-24T16:46:38.292156Z 5607ce8 Draft marked ready
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@mergify

mergify Bot commented Oct 24, 2026 •

Copy link
Copy Markdown
Contributor

Queued — the merge queue status continues in this comment ↓.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🔇 Additional comments: 5
docs/INTEGRATION-VALIDATION-PLAN.md: 1

1-20: LGTM!

Also applies to: 22-41, 42-56, 57-72, 73-92, 94-124, 126-145, 147-173, 175-201, 203-213

docs/dark-mode-troubleshooting.md: 1

2-126: LGTM!

docs/ebook-preferences.md: 1

1-70: LGTM!

docs/NETLIFY_CACHE_VERIFICATION.md: 1

164-167: 📐 Maintainability & Code Quality

The patch-evidence links are accessible.

Both commit URLs return HTTP 200 without authentication. No link replacement or qualification is required.

docs/TESTING.md-145-146: 1

145-146: Minor · Functional Correctness · Quick win

⚠️ Unverified finding
Verification ran but could not confirm this finding. It is shown for review, not as a verified issue.

Qualify the postinstall claim.

npm ci runs the postinstall script, but that script exits before lefthook install when the command is outside a Git worktree. State that Lefthook is installed only inside a Git worktree.


Review info
Run configuration
Commits

Reviewing files that changed from the base of the PR and between f99275b and 5607ce8.

Files selected for processing: 8
  • docs/INTEGRATION-VALIDATION-PLAN.md
  • docs/NETLIFY_CACHE_VERIFICATION.md
  • docs/TESTING.md
  • docs/dark-mode-troubleshooting.md
  • docs/ebook-preferences.md
  • docs/figma-ai-brief-1.md
  • docs/makeup-kit-essentials.md
  • docs/pending-questions.md
Files with no reviewable changes: 3
  • docs/figma-ai-brief-1.md
  • docs/makeup-kit-essentials.md
  • docs/pending-questions.md

Included review availability: This review used your included allowance. 1 included review remains after this review. Your included PR review attempts over the past 7 days set your current allowance at 5 reviews per hour.

@ashleyshaw ashleyshaw changed the title docs: apply bounded repository legacy cleanup docs: repository - Remove obsolete guidance and documents Oct 25, 2026
@ashleyshaw

Copy link
Copy Markdown
Member Author

@Mergifyio rebase

@mergify

mergify Bot commented Oct 25, 2026

Copy link
Copy Markdown
Contributor

rebase

☑️ Nothing to do, the required conditions are not met

Details
  • any of:
    • #commits-behind > 0 [📌 rebase requirement]
    • -linear-history [📌 rebase requirement]
  • -closed [📌 rebase requirement]
  • -conflict [📌 rebase requirement]
  • queue-position = -1 [📌 rebase requirement]

@ashleyshaw

Copy link
Copy Markdown
Member Author

@Mergifyio queue

@mergify

mergify Bot commented Oct 25, 2026 •

Copy link
Copy Markdown
Contributor

Merge Queue Status

  • ✅ Entered queue — 2026-10-25 01:18 UTC · Rule: default · triggered by @ashleyshaw with the @mergifyio queue command
  • ✅ Checks skipped · PR is already up-to-date
  • ✅ Merged — 2026-10-25 01:18 UTC · at eba637a0c9d5a021b7b625bb06b657597e827cbb

This pull request spent 17 seconds in the queue, including 1 second running CI.

Required conditions to merge

@mergify mergify Bot added the queued label Oct 25, 2026
@mergify
mergify Bot merged commit eba637a into develop Oct 25, 2026
71 of 73 checks passed
@mergify
mergify Bot deleted the docs/repository-legacy-cleanup branch October 25, 2026 01:18
@mergify mergify Bot removed the queued label Oct 25, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant