docs: add Wren Engine documentation#1437
Conversation
Add getting started guide, quickstart, MDL reference, and wren-project docs. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
📝 WalkthroughWalkthroughThis PR adds three new comprehensive documentation files totaling 770 lines, providing guidance for Wren Engine integration with Claude Code, a quickstart workflow with the jaffle_shop dataset, and MDL project structure details. No code changes or exported declarations are modified. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Possibly related PRs
Suggested labels
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ 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: 4
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/getting_started_with_claude_code.md`:
- Around line 67-84: Replace the inconsistent workspace path
'/${PWD}/wren-workspace' with '~/wren-workspace' in the
docs/getting_started_with_claude_code.md so the manual setup and the container
mount match; update the code block language tag for the mkdir example to bash
and change the example tree header from '/${PWD}/wren-workspace/' to
'~/wren-workspace/'; apply the same replacements to the other occurrence noted
(the block around lines 126-140) so all examples and mkdir commands reference
the same ~/wren-workspace path.
In `@docs/quickstart.md`:
- Around line 235-236: The troubleshooting step for "dbt build fails — adapter
not found" flips from the Step 1 virtualenv (.venv) flow to suggesting `uv tool
install dbt-duckdb`, which can leave users invoking a different `dbt` binary;
make the recovery path consistent with Step 1 by instructing users to install
the duckdb adapter into the same environment that runs `dbt` (either install
`dbt-duckdb` into the project .venv used in Step 1 or ensure the shell is using
the `uv`-managed `dbt` binary before running `dbt build`), and mention the
relevant commands and the symbols `dbt build`, `dbt-duckdb`, `.venv`, and `uv
tool install` so readers know which binaries/environments to align.
In `@docs/wren_project.md`:
- Around line 71-89: The example YAML and mapping table incorrectly include
per-column is_primary_key/isPrimaryKey; remove any is_primary_key entries from
the columns block and remove the snake_case→camelCase mapping that maps
is_primary_key→isPrimaryKey, and instead ensure the doc shows the model-level
primary_key (e.g., primary_key: order_id) which corresponds to the DTO field
primaryKey in mcp-server/app/dto.py; update examples and text to reference only
the model-level primary_key/primaryKey and not a per-column
is_primary_key/isPrimaryKey.
- Line 192: Remove the stray trailing 'v' from the step heading text "**5.
Commit to version control**v" so the heading reads "**5. Commit to version
control**"; locate the heading line in docs/wren_project.md (the line containing
the exact string "**5. Commit to version control**v") and delete the extra
character so the numbered step renders correctly.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 3c06c723-d43b-43c8-ba4a-1ea637c74ea8
📒 Files selected for processing (4)
docs/README.mddocs/getting_started_with_claude_code.mddocs/quickstart.mddocs/wren_project.md
- Make workspace path consistent (/${PWD}/wren-workspace) across mkdir, docker run mount, and troubleshooting
- Add missing language tag to fenced code block (MD040)
- Fix dbt adapter troubleshooting to use .venv consistent with Step 1 in quickstart.md
- Remove incorrect per-column is_primary_key from wren_project.md (it's model-level only)
- Fix stray trailing 'v' in step 5 heading
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
Summary
docs/README.md— documentation indexdocs/quickstart.md— quick start guidedocs/getting_started_with_claude_code.md— Claude Code integration guidedocs/wren_project.md— wren-project skill and MDL project workflow referenceTest plan
🤖 Generated with Claude Code
Summary by CodeRabbit