Repository navigation
fix(driver): reject unknown gamuts and align validation error types - #237
Merged
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
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 was referenced Oct 8, 2026
This was referenced Oct 8, 2026
pbroom
force-pushed
the
fix/api-doc-findings-validation
branch
from
October 8, 2026 17:04
02cd00c to
3628071
Compare
pbroom
force-pushed
the
fix/api-doc-findings-validation
branch
from
October 8, 2026 18:45
3628071 to
800d652
Compare
pbroom
commented
Oct 8, 2026
pbroom
left a comment
pbroom
left a comment
Owner
Author
There was a problem hiding this comment.
Reviewed the full incremental PR and its corrections at 800d6526182f84f1cbd1d384b6a162dcd795dbec. Gamut validation and error types reviewed; no remaining finding. No remaining actionable findings in the reviewed scope.
Independent correction re-reviews and stack preservation verification passed. At the integrated tip, lint, full build/DTS, 2,208 tests, formatting, strict agent checks and 14 built-site Chrome tests passed. All recorded actionable review threads are addressed. Hosted CI is being verified separately; this review does not authorize merge or release.
This was referenced Oct 9, 2026
pbroom
force-pushed
the
fix/api-doc-findings-validation
branch
from
October 10, 2026 02:39
800d652 to
6a34dbd
Compare
Owner
Author
Validate the active gamut with core's assertGamutTarget in createColorState, setColorActiveGamut, createMultiColorModel, setMultiColorActiveGamut and getColorDisplayStyles, so 'p3' throws the same TypeError as the core plane queries instead of rendering sRGB. The reducers also reject a missing gamut. sampleSliderGradient now throws a RangeError for steps below 2, and the multi-color entry builders throw a TypeError for colors that are neither strings nor objects instead of storing an empty color. Co-Authored-By: Claude Opus 5.5 <[email protected]>
pbroom
force-pushed
the
fix/api-doc-findings-validation
branch
from
October 10, 2026 20:07
6a34dbd to
657eb67
Compare
pbroom
added a commit
that referenced
this pull request
Oct 10, 2026
## Summary Docs overhaul slice S2: a generated API reference built into the site. It replaces the TypeDoc HTML output that used to live in `/reference`. - **Generator** (`apps/docs/scripts/api`). It runs TypeDoc JSON for every entry point in `packages/color-kit/package.json#exports`. - The JSON is normalized into `src/generated/api.json`, plus page files per entry and per symbol, typed by `src/api/model.ts`. All of these are gitignored and built by `pnpm docs:api`. - Each declaration gets one page, in its most specific entry. Other entries list it as a re-export. - Links resolve at generation time. - **Routes**, all prerendered: - `/api`. - `/api/:entry`: domains, kind glyphs, a narrative MDX slot and re-exports. - `/api/:entry/:Symbol`: declaration, params, returns, throws, build-time highlighted examples, a notes MDX slot, see also, "also exported from" and a source link at the commit. - **`<Signature>`** implements the S1 contract. It comes with `<Params>`, `<TypeLink>` and a responsive layout with one parameter per line. - **⌘K**: symbol hits come from the API routes, ranked by name, word and initials. - **Drift test** checks three things: - every export in the facade `.d.ts` has a page - every exports subpath is documented - every `/api` link resolves Rebased onto #241 with no conflicts. The generated reference reflects the #237–#241 surface; for example, `PlaneWithSense` has no page. ## Verified - On this branch: `pnpm build` and `pnpm test`. - Builds 523 prerendered routes. - Bundle check passes: the largest chunk is 194.8 kB against a 200 kB limit, and home initial JS is 91.0 kB gzip against a 110 kB limit. - Docs tests pass: 584 tests. - At the stack top (#244): lint, format:check, typecheck, size, check:artifacts, check:preprod and agents:check:strict all pass. - Browser checks at the stack top: - `/api/plane/sense` and `/api/core/Color` render. - ⌘K returns symbol hits and opens the selected page. - No horizontal scroll at 375 px. - No console errors or hydration warnings. Part of the color-kit assessment stack. 🤖 Generated with [Claude Code](https://claude.com/claude-code)
pbroom
added a commit
that referenced
this pull request
Oct 10, 2026
Delete the last legacy page (_legacy/api/plane-api.mdx); its quick start now lives in src/examples/plane and its prose in the plane narrative and concepts. The content link test now resolves internal links against the route registry built from the generated API data, so /api links must name a generated page (canonical entry only) instead of a barrel export parsed from source. Member anchors stay with the API drift test. Reflect the #237-#241 behaviour fixes: the headless picker guide notes that the driver rejects 'p3' and adds a typed-input section showing that percentages in an expression are positions in the range; the core narrative notes saturate/desaturate are uncapped above 0.4; the plane narrative notes planeHue returns an OKLCH hue. Co-Authored-By: Claude Opus 5.5 <[email protected]>
pbroom
added a commit
that referenced
this pull request
Oct 10, 2026
## Summary Docs overhaul slice S4: concept pages, guides and narratives for each entry point. A small commit on top finishes the integration with S2, S3 and #237–#241. **Content** - Five concepts: - OKLCH-canonical colors - requested vs displayed - planes and queries - gamut and tolerance - contrast - Five guides, each with one live example under `src/examples/{guides,driver}`: - a headless picker with `color-kit/driver` - `color-kit/react` - contrast-aware palettes - GPU and three.js interop - performance - A narrative `index.mdx` for each of the core, plane, interop, compute, hct and driver entry points. - A polished `/start` quick start. - The mined legacy MDX is deleted. **Integration commit** - Deletes the last legacy page, `_legacy/api/plane-api.mdx`, which had the stray "normalized" aside. Its quick start is now in S3's `src/examples/plane/quick-start.tsx`. No `_legacy` files remain. - Rewrites the content link test to check against the route registry built from the generated API data. Every `/api` link must name a generated page, which means the canonical entry only, so root re-exports fail. Member anchors stay with S2's drift test. - Brings the content in line with #237–#241: - The headless picker guide notes that the driver rejects `'p3'` with the same `TypeError` as core. - A new "Typed input" section shows that a `%` in an expression is a position in the range, so `50% * 2` on `[100, 200]` gives 300. - The core narrative says `saturate`/`desaturate` clamp chroma only at 0. - The plane narrative says `planeHue` returns an OKLCH hue. - No content references `PlaneWithSense`. ## Verified - `pnpm build` and `pnpm test` pass. Docs tests pass: 792 tests, including the content link test and the API drift test. - A negative check confirms that `/api/core/definePlane` and `/api/core/PlaneWithSense` fail the link test. - The new snippet values were checked against the built facade. - These gates pass: lint, format:check, typecheck, size, check:artifacts, check:preprod and agents:check:strict. - Docs chunk budget: the largest chunk is 194.8 kB against a 200 kB limit. - Docs home budget: home initial JS is 101.6 kB gzip against a 110 kB limit. - Browser checks on the built site: - home hero drag - `/start` - `/concepts/planes-and-queries` - `/guides/headless-picker` - `/api/plane/sense` - `/api/core/Color` - ⌘K - light and dark themes - 375 px with no horizontal scroll - no console errors or hydration warnings Part of the color-kit assessment stack. 🤖 Generated with [Claude Code](https://claude.com/claude-code)
This branch was successfully deployed
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.
Validate the active gamut with core's assertGamutTarget in
createColorState, setColorActiveGamut, createMultiColorModel,
setMultiColorActiveGamut and getColorDisplayStyles, so 'p3' throws the
same TypeError as the core plane queries instead of rendering sRGB.
The reducers also reject a missing gamut.
sampleSliderGradient now throws a RangeError for steps below 2, and the
multi-color entry builders throw a TypeError for colors that are neither
strings nor objects instead of storing an empty color.
Found while documenting the public API in #235. Each finding was reproduced against the built package before the fix, has a regression test, and its affected JSDoc examples were recomputed. lint, build, test, format:check, typecheck, size, check:artifacts, check:preprod and agents:check:strict pass.
Part of the color-kit assessment stack.
🤖 Generated with Claude Code