docs: end-to-end consistency pass for the v4 API - #6
Merged
Merged
Conversation
IMPLEMENTATION.md:
- Add section 4 "Multiple selection" (chips, array value, submitFormat table,
Express normalize tip); renumber MongoDB/EJS/Blaze/Theming/Security to 5–9.
- enhance() section: note <select multiple> auto-upgrade.
- Fix search-route response shape to { value, label, sublabel } (raw is opt-in
via exposeRaw), with a pointer to the security model.
- Client async section: document automatic AbortSignal cancellation + cache:true.
- Rewrite the "A note on required": required now DOES block submit via Constraint
Validation on the visible input (3.3.0) — the old "cosmetic only" text was wrong.
README.md:
- Size claim ~12 KB → ~14 KB gzipped (JS) + ~2 KB CSS (measured).
- CI matrix Node 18/20/22 → 18/20/22/24; broaden the test-coverage sentence.
Verified all in-page anchors in both docs resolve. No code/version change.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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
1 participant
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.
Summary
Exhaustive consistency sweep of the docs now that the API has grown through v4.0.0. Docs-only — no code or version change.
IMPLEMENTATION.md
submitFormattable (repeat/bracket/delimited → what each server sees), and an Express normalize tip. Renumbered MongoDB/EJS/Blaze/Theming/Security to 5–9 (TOC + anchors updated).enhance()section now notes<select multiple>auto-upgrade.{ value, label, sublabel }(raw is opt-in viaexposeRaw), with a pointer to the security model — the old line listedrawunconditionally.AbortSignalcancellation andcache: true.required" — it claimed required was cosmetic and "does not block submission." That's been false since 3.3.0: required is enforced via the Constraint Validation API on the visible input. This was the most important fix.README.md
Verification
npm test→ 45/45 (unchanged; docs-only).🤖 Generated with Claude Code