-
Notifications
You must be signed in to change notification settings - Fork 181
docs(skills): add file-based connector docs, venv setup, and fix path/typo issues #1438
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
6101298
3424482
bcd7bc7
e270639
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,9 +1,9 @@ | ||
| { | ||
| "generate-mdl": "1.2", | ||
| "wren-connection-info": "1.1", | ||
| "wren-connection-info": "1.2", | ||
| "wren-project": "1.4", | ||
| "wren-sql": "1.0", | ||
| "wren-mcp-setup": "1.2", | ||
| "wren-quickstart": "1.0", | ||
| "wren-quickstart": "1.1", | ||
| "wren-usage": "1.0" | ||
| } |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -5,18 +5,18 @@ compatibility: Requires Docker Desktop (or Docker Engine). No local database dri | |
| license: Apache-2.0 | ||
| metadata: | ||
| author: wren-engine | ||
| version: "1.0" | ||
| version: "1.1" | ||
| --- | ||
|
|
||
| # Wren Quickstart | ||
|
|
||
| ## Version check | ||
|
|
||
| Silently fetch `https://raw.githubusercontent.com/Canner/wren-engine/main/skills/versions.json`. | ||
| Compare the `wren-quickstart` key with this skill's version (`1.0`). | ||
| Compare the `wren-quickstart` key with this skill's version (`1.1`). | ||
| If the remote version is newer, notify the user before proceeding: | ||
|
|
||
| > A newer version of the **wren-quickstart** skill is available (remote: X.Y, installed: 1.0). | ||
| > A newer version of the **wren-quickstart** skill is available (remote: X.Y, installed: 1.1). | ||
| > Update with: | ||
| > ```bash | ||
| > curl -fsSL https://raw.githubusercontent.com/Canner/wren-engine/main/skills/install.sh | bash -s -- --force wren-quickstart | ||
|
|
@@ -34,12 +34,27 @@ This skill walks a user through setting up Wren Engine end-to-end — from creat | |
|
|
||
| ## Phase 1 — Create a workspace | ||
|
|
||
| ### 1a — Set up Python virtual environment | ||
|
|
||
| Before creating the workspace, ensure a Python virtual environment is available. This is required if the user will run **ibis-server locally** (instead of relying solely on Docker). Skip this step if the user will use only the Dockerized ibis-server. | ||
|
|
||
| ```bash | ||
| python3 -m venv .venv | ||
| source .venv/bin/activate # macOS / Linux | ||
| # .venv\Scripts\activate # Windows | ||
| pip install --upgrade pip | ||
| ``` | ||
|
|
||
| > **Tip:** Place the venv inside or adjacent to the workspace directory so it is easy to find. Avoid committing it to version control — add `.venv/` to `.gitignore`. | ||
|
|
||
| ### 1b — Create a workspace directory | ||
|
|
||
| Create a dedicated workspace directory on the host machine. This directory will be mounted into the Docker container, so the container can read and write MDL files. | ||
|
|
||
| Ask the user where they want the workspace, or suggest a default: | ||
|
|
||
| ```bash | ||
| mkdir -p ~/wren-workspace | ||
| mkdir -p ${PWD}/wren-workspace | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🧩 Analysis chain🏁 Script executed: #!/bin/bash
# Check for workspace path references across skill files
echo "=== Checking workspace path patterns in skills ==="
rg -n "wren-workspace" --type md skills/Repository: Canner/wren-engine Length of output: 762 🏁 Script executed: # Check Phase 3 in wren-quickstart and the getting_started docs reference
cat skills/wren-quickstart/SKILL.md | head -80Repository: Canner/wren-engine Length of output: 3232 🏁 Script executed: # Check the getting_started docs for path references
rg -n "wren-workspace" --type md docs/Repository: Canner/wren-engine Length of output: 760 🏁 Script executed: # Search for Phase 3 and `@wren-mcp-setup` in wren-quickstart
rg -n "Phase 3|@wren-mcp-setup" skills/wren-quickstart/SKILL.mdRepository: Canner/wren-engine Length of output: 611 🏁 Script executed: # Get full wren-quickstart file to verify Phase 3
wc -l skills/wren-quickstart/SKILL.mdRepository: Canner/wren-engine Length of output: 97 Cross-skill path inconsistency requires follow-up fix.
🤖 Prompt for AI Agents |
||
| ``` | ||
|
|
||
| Save the chosen path as `<WORKSPACE_PATH>` (absolute path, e.g. `/Users/me/wren-workspace`). All subsequent steps reference this path. | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Path fix is correct, but internal inconsistency remains.
The fix from
/${PWD}/wren-workspaceto${PWD}/wren-workspaceis correct — the leading slash would have created an invalid path.However, there's an inconsistency within this file: Phase 1 (line 68) now uses
${PWD}/wren-workspace, but Phase 2's docker run command (line 139) still uses~/wren-workspace:Consider updating line 139 to match, or using a variable like
$WORKSPACE_PATHthat can be set to either location.🧰 Tools
🪛 markdownlint-cli2 (0.21.0)
[warning] 73-73: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 Prompt for AI Agents