docs(sdk): add wren-core-wasm SDK page#2284
Conversation
New docs/core/sdk/wasm.md following the same structure as langchain.md and pydantic.md — covering when to use it, install (npm + CDN), three quickstart patterns (URL mode / inline register* / cubeQuery), full API reference, integration patterns, troubleshooting, and limitations. Also: - overview.md: list wasm as an Available SDK; promote pydantic out of "Coming soon" since it's already shipped. - cube.md: link to the new wasm.md alongside the AGENT_GUIDE for the WASM section. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Repository UI Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/core/sdk/wasm.md`:
- Line 54: The document contains inconsistent WASM size values: the sentence
containing "the WASM binary is ~68 MB raw." conflicts with other occurrences of
"~72 MB"; please verify the actual WASM binary size and replace all occurrences
of "~68 MB" and "~72 MB" with the verified, single correct value so the document
is consistent (search for the exact strings "the WASM binary is ~68 MB raw." and
"~72 MB" to locate each instance).
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository UI
Review profile: CHILL
Plan: Pro
Run ID: 0323e2d6-0a17-493f-a7ed-fab36362cc38
📒 Files selected for processing (3)
docs/core/guides/modeling/cube.mddocs/core/sdk/overview.mddocs/core/sdk/wasm.md
Verified with `just size` (72.3 MB raw, 15.0 MB gzip). The "~68 MB" and "~22 MB gzip" figures were stale predecessors. Standardised on "~72 MB raw / ~15 MB gzip" throughout the page. CodeRabbit on PR #2284. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/core/sdk/wasm.md`:
- Around line 98-99: The docs use two different terms for an empty
profile.source (''), causing confusion; pick one consistent term (e.g., call
empty profile.source '' "auto-detect mode") and update all occurrences to that
term or explicitly document the distinction (e.g., clarify that profile.source:
'' enables auto-detect while "local mode" refers to an explicit local path).
Update the lines referencing loadMDL and any mentions at the other indicated
spots (around the examples using profile.source, pre-register tables before
loadMDL, and the examples at the later sections) so every mention of
profile.source: '' uses the chosen term and add one brief sentence where needed
to state the difference between auto-detect (empty string) and an explicit local
path.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository UI
Review profile: CHILL
Plan: Pro
Run ID: 1e040611-fce2-438b-887c-27bcc4bc2159
📒 Files selected for processing (1)
docs/core/sdk/wasm.md
CodeRabbit flagged that the doc used "local mode" and "fallback" both for empty source. Per the Rust API doc the three modes are distinct: - URL mode — http(s) prefix → ListingTables auto-registered - Auto-detect mode — empty string → picks URL or local per model - Strict local mode — any other non-URL string → pre-registered tables only; missing → eager "Unresolved models" error Renamed the inline example label from "local mode" to "auto-detect", clarified the API reference table, and added a one-sentence note on which mode to pick. Also updated the troubleshooting row that mentioned "Local mode" to "Strict local mode" for consistency. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Summary
Adds a dedicated SDK page for the browser/WASM build, mirroring the structure of
langchain.mdandpydantic.md:registerJson/registerCsv/registerParquet), cube queries.WrenEngineincluding the fullCsvReadOptionstable.Other touch-ups
overview.md: list wasm as an Available SDK; move pydantic out of "Coming soon" since it's shipped.cube.md: link to the new wasm.md alongside the existing AGENT_GUIDE link.PR target
Targets
feat/wasm-cubeso this docs PR rides the same train as the rest of the cube/WASM work (PRs #2264 – #2283).Test plan
./langchain.md,./pydantic.md,../guides/modeling/cube.md).registerCsvmatches the Rust accept list (incl.date32).CubeQueryInputshape matchescore/wren-core-wasm/sdk/src/index.ts.🤖 Generated with Claude Code
Summary by CodeRabbit