Skip to content

Simplify documentation and narrow runtime packaging - #44

Merged
aaron-seq merged 2 commits into
mainfrom
codex/cleanup-docs-and-package
Oct 27, 2026
Merged

aaron-seq merged 2 commits into
mainfrom
codex/cleanup-docs-and-package

Conversation

@aaron-seq

@aaron-seq aaron-seq commented Oct 26, 2026 •

Copy link
Copy Markdown
Owner

The README puts npm ci in the user installation path, contribution examples refer to nonexistent modules/selectors, and setup/review/validation prose is repeated across several pages. This change uses the real tests, gives each topic a canonical guide, preserves historical evidence at existing URLs with revision links, and keeps three development configs out of the npm tarball.

Closes #35. Based on main 6e8288550ef4935684a6a44c87cbbed77b818d14; cleanup implementation 397b9c306a6f52b8e58f6a49451ea9faa4050e0c has locally tested tree 8229dff5568dffac2f3f02ebd41fc9146ad530e9. Final head 6ea9cdcf03408f690f97c946ee80db6a07218a1a adds only a documentation correction for the pre-existing Codecov rejection.

Changes and decisions

Paths Decision and evidence
README, CONTRIBUTING, PR template, DEVELOPMENT Simplify/merge duplicate guidance; replace fictional test imports/selectors with the existing renderer case and persistent Chromium fixture. The packed-consumer smoke confirms installation without npm.
Existing evidence pages, SECURITY, product checkpoint Shorten repeated inventories/narration; retain decisions, response/review policies, contracts, results, limits, and exact-revision links to the original records. Existing filenames/known inbound anchors survive.
package.json Replace root globs with six explicit runtime files, retain runtime directories/assets/license, and remove redundant custom prose metadata. Configs remain in the repository. Lockfile/dependency versions unchanged.
Ignored coverage/ and test-results/ Removed 30 reproducible passed-run files (886,716 bytes). Regenerate with coverage/E2E commands. Resolved literal paths and every descendant were checked for containment, reparse points, and nested repositories; removal previewed.
Runtime/tests/assets, supplied brief, research, release history, LICENSE, Code of Conduct, installed environment, worktrees Retain. All 17 runtime files are reachable; no proven dead module/dependency justified removal. Legacy ignored dist/ is retained because its recovery/regeneration path is unproven.

Measurements

Metric Before After Scope and measurement
Tracked files / bytes 71 / 740,617 71 / 693,635 Git tree blob bytes, base → this commit; 46,982 fewer bytes
Maintained runtime source lines 5,321 5,321 Same 17 JS/HTML/CSS runtime files
Documentation files / words 14 / 19,796 14 / 14,288 All tracked Markdown, whitespace words; 27.8% fewer words
npm tarball 48,010 bytes / 28 files 44,750 bytes / 25 files Equivalent clean Git exports, npm 11.6.2; 6.8% smaller; unpacked 187,837 → 178,755 bytes
Local disposable output 886,716 bytes / 30 files 0 Only checkout coverage/ and test-results/; distinct from tracked content/history

Validation

Run locally on Windows / Node 22.18.0 / npm 11.6.2:

  • Baseline: verify + coverage (311 tests / 13 files), E2E (20) passed.
  • Cleanup implementation 397b9c3: clean Git-tree export, fresh npm ci with Husky disabled for the non-Git export; npm run verify, npm run test:coverage (311 / 13), npm run test:e2e (20, zero retries), and npm audit --audit-level=high passed (zero vulnerabilities reported).
  • Candidate coverage: statements 94.66%, branches 84.44%, functions 95.09%, lines 96.68%; existing floors unchanged.
  • Documented renderer command: 16 tests passed. Temporary local link diagnostic: 87 local/heading/pinned-object references checked, zero failures (83 at base); supplied verbatim brief excluded from navigation checks.
  • Actual npm pack: 25 files, all 21 runtime references present, file contents matched the export (npm-normalized package metadata excepted). Consumer smoke loaded the extracted tarball with no node_modules, rendered Settings, extracted a fixture page, and generated one intercepted-provider summary.
  • Scoped Prettier, precommit hooks, diff check and read-only second-agent review completed. Two wording errors were corrected and independently verified; agent review is not human approval.

Initial CI at 397b9c3 passed all six jobs; the downloaded artifact (12686354730) contained 24 files and all 21 runtime references, with packaged bytes matching the checkout after text line-ending normalization. Final-head CI checks the documentation correction at 6ea9cdc. Runtime and package inputs are identical to 397b9c3. Optional Codecov uploading failed despite green job status: the final uploader error rejects tokenless authentication. Issue #45 records the same failure in pre-cleanup main logs and corrects the earlier acceptance claim on #32; coverage thresholds passed. No workflow/credential/service setting was changed. Local diagnostics are temporary harnesses, not new repository CI gates; the fresh export/install/profile directory was removed after validation (excluded from baseline savings). Providers were substituted; no live-key/model-quality, minimum-browser, native OS, or external-link availability claim. Separate UI draft #39 is not integrated. No runtime speed or clone-size improvement is claimed; Git history is preserved.

Risks and rollback

Explicit npm/CI allowlists must be maintained when runtime files are added. Some historical detail now requires the pinned GitHub record. Revert this commit to restore the prior prose/package list; no data/schema migration is needed. No release or deployment.

@aaron-seq
aaron-seq marked this pull request as ready for review October 27, 2026 05:46
@aaron-seq
aaron-seq merged commit bd0e0f7 into main Oct 27, 2026
12 checks passed
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 27, 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-27T05:47:36.621902Z 6ea9cdc 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.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Align contribution examples with the current Chrome extension source

1 participant