Skip to content

docs: add Wren Engine documentation#1437

Merged
douenergy merged 1 commit intoCanner:mainfrom
goldmedal:chore/wren-docs
Mar 10, 2026
Merged

docs: add Wren Engine documentation#1437
douenergy merged 1 commit intoCanner:mainfrom
goldmedal:chore/wren-docs

Conversation

@goldmedal
Copy link
Copy Markdown
Contributor

@goldmedal goldmedal commented Mar 10, 2026

Summary

  • Add docs/README.md — documentation index
  • Add docs/quickstart.md — quick start guide
  • Add docs/getting_started_with_claude_code.md — Claude Code integration guide
  • Add docs/wren_project.md — wren-project skill and MDL project workflow reference

Test plan

  • Review docs for accuracy and completeness
  • Verify links are correct

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Added comprehensive Getting Started guide for integrating Claude Code with Wren Engine, covering installation, setup, and verification
    • Added complete quickstart guide for the jaffle_shop dataset workflow using Wren Engine and Claude Code
    • Added detailed documentation on Wren MDL project structure, file organization, and build workflow

Add getting started guide, quickstart, MDL reference, and wren-project docs.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Mar 10, 2026
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Mar 10, 2026

📝 Walkthrough

Walkthrough

This 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

Cohort / File(s) Summary
Documentation
docs/getting_started_with_claude_code.md, docs/quickstart.md, docs/wren_project.md
Three new documentation files covering: Claude Code integration end-to-end guide (prerequisites, installation, manual setup phases, troubleshooting); jaffle_shop quickstart workflow with automated/manual Wren Engine configuration paths; and Wren MDL project structure, file organization, field mappings, and build workflow.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

Suggested labels

documentation

Suggested reviewers

  • douenergy
  • wwwy3y3

Poem

🐰 A rabbit hops through docs so new,
Wren Engine paths, both clear and true,
From quickstart seeds to MDL arrays,
Claude Code dances through setup's maze,
Getting started made easy today! ✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately reflects the main change—adding Wren Engine documentation files. It is concise, specific, and clearly summarizes the primary objective of the PR.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@goldmedal goldmedal requested a review from douenergy March 10, 2026 06:57
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

📥 Commits

Reviewing files that changed from the base of the PR and between 7a5438b and 6bb90a5.

📒 Files selected for processing (4)
  • docs/README.md
  • docs/getting_started_with_claude_code.md
  • docs/quickstart.md
  • docs/wren_project.md

goldmedal added a commit that referenced this pull request Mar 10, 2026
- 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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants