Repository navigation
Simplify documentation and narrow runtime packaging - #44
Merged
Merged
Conversation
This was referenced Oct 26, 2026
aaron-seq
marked this pull request as ready for review
October 27, 2026 05:46
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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 implementation397b9c306a6f52b8e58f6a49451ea9faa4050e0chas locally tested tree8229dff5568dffac2f3f02ebd41fc9146ad530e9. Final head6ea9cdcf03408f690f97c946ee80db6a07218a1aadds only a documentation correction for the pre-existing Codecov rejection.Changes and decisions
Measurements
Validation
Run locally on Windows / Node 22.18.0 / npm 11.6.2:
npm ciwith Husky disabled for the non-Git export;npm run verify,npm run test:coverage(311 / 13),npm run test:e2e(20, zero retries), andnpm audit --audit-level=highpassed (zero vulnerabilities reported).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.