docs(core): refine IA — Quickstart per agent + question-titled concepts#2311
Merged
Conversation
Major restructure aligned with docs.getwren.ai PR #315: - Get Started: add quickstart-with-agent/ with 53 supported agents (Claude Code, Cursor, Codex, Continue, Cline, Roo, Windsurf, ...); each page has prerequisites, install command, start-session instruction (CLI / IDE / cloud variant), and the canonical onboarding-skill prompt - Concepts: 6 question-titled pages — what_is_context, agent_learning (new), memory_system, what_is_mdl, correctness (new), stack_position (new) - Guides: 5 outcome recipe cards — connect, model (new), refine (new), cubes (new), manage_project (new); deleted modeling/ subfolder (field-level detail moved to reference/mdl.md), memory.md, profiles.md, use-with-agents/ - Reference: add mdl.md (consolidates project + models + relations + views + cubes + instructions), architecture.md (moved from concepts/, renamed WrenEngine section to Wren Python SDK), operational.md (paths + env vars + discovery rules) - Overview: tease six concept pages with deep-links; merge "How it fits your stack" into "How you use it" The doc site sidebar + redirects to match are in Canner/docs.getwren.ai PR #315. After this merges, sync-docs workflow will propagate the docs/ changes there. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
github-actions
Bot
added
the
documentation
Contributor
|
Caution Review failedThe pull request is closed. ℹ️ Recent review info⚙️ Run configurationConfiguration used: Repository UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (83)
WalkthroughThis PR is a comprehensive documentation restructure for the Wren AI project, rewriting conceptual narrative around the "context layer" model, adding 50+ agent integration guides, reorganizing workflow-focused guides (replacing the old modeling structure), and establishing new reference documentation for architecture and operational configuration. No code changes. ChangesCore Concept & Introduction Rewrite
Agent Integration Quickstarts
Guides Restructuring: From Modeling to Workflows
Reference Documentation & Link Updates
🎯 2 (Simple) | ⏱️ ~15 minutes Possibly Related PRs
Suggested Labels
Suggested Reviewers
✨ 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 |
goldmedal
approved these changes
May 20, 2026
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
2 participants
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.
Summary
Major IA restructure of
docs/core/. The companion doc-site PR is Canner/docs.getwren.ai#315 — after both land, the sync-docs workflow will mirror this content over.What changed
Get Started
installation.md— kept as the flat skill-bundle install (npx skills add ...+ onboarding-skill prompt)quickstart-with-agent/— new folder with 53 per-agent install pages (Claude Code, Cursor, Codex, Continue, Cline, Cursor, Goose, Windsurf, OpenCode, Roo, …). Each page has prerequisite, the canonicalnpx skills add Canner/WrenAI --skill '*' --agent <flag>command, an agent-specific session-start instruction (CLI / IDE / cloud), and the/wren-onboardingslash-command promptquickstart.md— link updates onlyConcepts (6 question-titled pages)
what_is_context.mdagent_learning.mdmemory_system.mdwhat_is_mdl.mdcorrectness.mdstack_position.mdDeleted:
concepts/skills.md,concepts/architecture.md(both moved toreference/).Guides (5 outcome recipe cards)
connect.mdmodel.mdrefine.mdwren-enrich-contextis in active development)cubes.mdmanage_project.mdDeleted:
guides/modeling/(6 files — field-level spec moved toreference/mdl.md),guides/memory.md,guides/profiles.md,guides/use-with-agents/claude-code.md.Reference (5 atomic pages)
cli.mdskills.mdmdl.mdarchitecture.mdconcepts/— renamedWrenEnginesection toWren Python SDK(per-review feedback); mermaid simplified to avoid layout overflowoperational.mdOverview (
introduction.mdx)Light edits: deep-link each section into the matching Concept page; merged "How it fits your stack" into "How you use it"; "Wren AI Core" → "Wren AI".
Test plan
🤖 Generated with Claude Code
Summary by CodeRabbit