Skip to content

docs: add per-module .claude/CLAUDE.md and redirect AGENTS.md#1466

Merged
goldmedal merged 3 commits intoCanner:mainfrom
goldmedal:chore/init-claude
Mar 20, 2026
Merged

docs: add per-module .claude/CLAUDE.md and redirect AGENTS.md#1466
goldmedal merged 3 commits intoCanner:mainfrom
goldmedal:chore/init-claude

Conversation

@goldmedal
Copy link
Copy Markdown
Contributor

@goldmedal goldmedal commented Mar 19, 2026

Summary

  • Create .claude/CLAUDE.md for each module (wren-core, wren-core-base, wren-core-py, wren-core-legacy, ibis-server, mcp-server) with module-specific build commands, architecture, and conventions
  • Add AGENTS.md redirects in all modules pointing to .claude/CLAUDE.md
  • Simplify root AGENTS.md to an index of module paths

Test plan

  • Verify each .claude/CLAUDE.md is picked up correctly when working within its module
  • Confirm AGENTS.md redirects are clear and point to the right files

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Replaced the single repository-level guide with module-scoped reference pages and concise pointers, improving discoverability.
    • Added new module documentation covering ibis-server, mcp-server, wren-core, wren-core-base, wren-core-py, and wren-core-legacy (architecture, usage, developer commands, environment settings, and known limits).
    • Converted AGENTS.md files to stubs directing readers to the module reference files.

goldmedal and others added 2 commits March 19, 2026 16:37
Create module-specific .claude/CLAUDE.md for wren-core, wren-core-base,
wren-core-py, and wren-core-legacy with build commands, architecture,
and conventions. Add AGENTS.md redirects in all modules (including
ibis-server and mcp-server) pointing to .claude/CLAUDE.md. Simplify
root AGENTS.md to an index of module paths.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@github-actions github-actions bot added documentation Improvements or additions to documentation core ibis rust Pull requests that update Rust code python Pull requests that update Python code labels Mar 19, 2026
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Mar 19, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 9e1217cc-af84-4164-b46a-8aa3d1595421

📥 Commits

Reviewing files that changed from the base of the PR and between 70d83f8 and 73ef04f.

📒 Files selected for processing (3)
  • ibis-server/.claude/CLAUDE.md
  • mcp-server/.claude/CLAUDE.md
  • wren-core/.claude/CLAUDE.md
✅ Files skipped from review due to trivial changes (3)
  • wren-core/.claude/CLAUDE.md
  • mcp-server/.claude/CLAUDE.md
  • ibis-server/.claude/CLAUDE.md

📝 Walkthrough

Walkthrough

This PR replaces the repository-level AGENTS.md with a pointer stub and adds module-scoped .claude/CLAUDE.md files plus per-module AGENTS.md pointer stubs for ibis-server, mcp-server, wren-core, wren-core-base, wren-core-py, and wren-core-legacy. (Docs-only reorganization.)

Changes

Cohort / File(s) Summary
Root-level AGENTS.md
AGENTS.md
Converted from a comprehensive repository guide to a pointer-only stub referencing module .claude/CLAUDE.md files.
Module Documentation
ibis-server/.claude/CLAUDE.md, mcp-server/.claude/CLAUDE.md, wren-core/.claude/CLAUDE.md, wren-core-base/.claude/CLAUDE.md, wren-core-py/.claude/CLAUDE.md, wren-core-legacy/.claude/CLAUDE.md
Added module-scoped CLAUDE.md docs describing architecture, request/engine flows, key components, build/test commands, env vars, and known limitations per module.
Module AGENTS.md Stubs
ibis-server/AGENTS.md, mcp-server/AGENTS.md, wren-core/AGENTS.md, wren-core-base/AGENTS.md, wren-core-py/AGENTS.md, wren-core-legacy/AGENTS.md
Added pointer-only AGENTS.md files in each module directing readers to the respective .claude/CLAUDE.md.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Suggested reviewers

  • douenergy

Poem

🐰 I hopped through folders, tidy and spry,
Stitched CLAUDE notes where guides used to lie.
Stubs point the way, each module aglow—
Docs in neat burrows, ready to show. 🥕

🚥 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 describes the main change: adding per-module .claude/CLAUDE.md files and creating AGENTS.md redirect files across the repository.
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
📝 Coding Plan
  • Generate coding plan for human review comments

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.

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: 3

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@ibis-server/.claude/CLAUDE.md`:
- Around line 7-15: The markdown has unlabeled/incorrect fenced code blocks and
missing blank lines around the Runtime table causing MD040/MD058 failures;
update each affected fenced block (the REST client block starting with "REST
client (MCP server / Wren Studio)" and the connector list block containing
"postgres  mysql  mssql ..." ) to use a language identifier (use "text" as
shown) and ensure there is a blank line immediately before and after each
triple-backtick fence, and add a blank line before and after the "**Runtime:**"
table so the table is separated by empty lines from surrounding text; no code
changes beyond replacing ``` with ```text and inserting the needed blank lines.

In `@mcp-server/.claude/CLAUDE.md`:
- Around line 7-12: The fenced code block that starts with "AI Agent
(Claude/Cline/Cursor)" is missing a language tag and triggers markdownlint
MD040; update the opening triple-backticks to include a language (e.g., ```text)
so the block becomes a labeled code fence and passes linting, leaving the block
content unchanged.

In `@wren-core/.claude/CLAUDE.md`:
- Line 27: Update the test command that currently shows "cargo test --lib
--tests --bins" to explicitly set the required stack size by prefixing it with
the environment variable RUST_MIN_STACK=8388608 (i.e., use
RUST_MIN_STACK=8388608 cargo test --lib --tests --bins) so the stack-size
requirement is not missed when copy-pasting; modify the line containing the
command string to include that env var and keep the existing comment if desired.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 8b48f5b2-dbac-49b8-96b4-2d314d705e7d

📥 Commits

Reviewing files that changed from the base of the PR and between 3527642 and 70d83f8.

📒 Files selected for processing (13)
  • AGENTS.md
  • ibis-server/.claude/CLAUDE.md
  • ibis-server/AGENTS.md
  • mcp-server/.claude/CLAUDE.md
  • mcp-server/AGENTS.md
  • wren-core-base/.claude/CLAUDE.md
  • wren-core-base/AGENTS.md
  • wren-core-legacy/.claude/CLAUDE.md
  • wren-core-legacy/AGENTS.md
  • wren-core-py/.claude/CLAUDE.md
  • wren-core-py/AGENTS.md
  • wren-core/.claude/CLAUDE.md
  • wren-core/AGENTS.md

- Add `text` language tag to unlabeled code fences (MD040)
- Add blank line before Runtime table (MD058)
- Make RUST_MIN_STACK explicit in wren-core test command

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@goldmedal goldmedal requested a review from wwwy3y3 March 20, 2026 01:48
@goldmedal goldmedal merged commit 12bdc4f into Canner:main Mar 20, 2026
15 checks passed
@goldmedal goldmedal deleted the chore/init-claude branch March 20, 2026 02:00
nhaluc1005 pushed a commit to nhaluc1005/text2sql-practice that referenced this pull request Apr 3, 2026
…#1466)

Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

core documentation Improvements or additions to documentation ibis python Pull requests that update Python code rust Pull requests that update Rust code

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants