Conversation
Add project guidance for Claude Code with build commands, architecture overview, and development conventions. Include extracted coding patterns and instincts from git history analysis.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
📝 WalkthroughWalkthroughThis PR introduces comprehensive documentation for the iii monorepo, including coding conventions (Biome formatting, Conventional Commits), architectural patterns (SDK synchronization, engine modules, install scripts), and a project guidance document for Claude Code integration. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes 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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In @.claude/instincts/iii-engine-module-pattern.md:
- Line 19: The documented module list is inaccurate; update the module line to
match engine/src/lib.rs which declares 17 top-level modules and uses snake_case.
Replace the current "Existing modules" entry with the correct snake_case list:
rest_api, queue, cron, stream, pubsub, state, kv_server, http_functions,
observability, shell, bridge_client, redis, registry, telemetry, worker, config,
module, and remove references to non-top-level names like Otel and Exec; ensure
capitalization is snake_case (e.g., rest_api) to match the codebase.
In @.claude/skills/iii-patterns.md:
- Around line 79-81: Update the fenced code block so it includes a language
specifier (use "text") to satisfy the markdown linter; locate the fence
containing the line "chore: bump versions for release -- iii(iii/v0.X.0)" and
change the opening triple backticks to "```text" so the block is treated as
plain text by the linter.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: d83a0e73-2509-4d1f-af15-b89e01bd72a5
📒 Files selected for processing (7)
.claude/instincts/iii-biome-formatting.md.claude/instincts/iii-commit-convention.md.claude/instincts/iii-cross-sdk-sync.md.claude/instincts/iii-engine-module-pattern.md.claude/instincts/iii-install-scripts-sync.md.claude/skills/iii-patterns.mdCLAUDE.md
| 4. Is composed into the engine in `engine/src/main.rs` | ||
|
|
||
| ## Evidence | ||
| - Existing modules: RestApi, Queue, Cron, Stream, PubSub, State, Otel, KvServer, Exec, HttpFunctions |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Description: List all top-level modules in the engine
# Find module declarations in lib.rs
rg -A 20 'pub mod modules' engine/src/lib.rsRepository: iii-hq/iii
Length of output: 473
Correct the module list for accuracy.
The documented module list doesn't accurately reflect the actual codebase structure. Based on engine/src/lib.rs, there are 17 top-level modules, not 10. The listed modules contain critical inaccuracies:
- "Otel" and "Exec" do not exist as top-level modules; they reference submodules within
observabilityandshellrespectively - Several top-level modules are missing:
bridge_client,config,module,redis,registry,telemetry,worker - Naming uses inconsistent capitalization (use snake_case:
rest_apinotRestApi)
Correct to:
Existing modules: rest_api, queue, cron, stream, pubsub, state, kv_server, http_functions, observability, shell, bridge_client, redis, registry, telemetry, worker, config, module🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In @.claude/instincts/iii-engine-module-pattern.md at line 19, The documented
module list is inaccurate; update the module line to match engine/src/lib.rs
which declares 17 top-level modules and uses snake_case. Replace the current
"Existing modules" entry with the correct snake_case list: rest_api, queue,
cron, stream, pubsub, state, kv_server, http_functions, observability, shell,
bridge_client, redis, registry, telemetry, worker, config, module, and remove
references to non-top-level names like Otel and Exec; ensure capitalization is
snake_case (e.g., rest_api) to match the codebase.
| ``` | ||
| chore: bump versions for release -- iii(iii/v0.X.0) | ||
| ``` |
There was a problem hiding this comment.
Add language specifier to code fence.
The markdown linter flags this fenced code block as missing a language specifier. Since this appears to be a generic text example (not executable code), consider adding text as the language identifier.
📝 Proposed fix
-```
+```text
chore: bump versions for release -- iii(iii/v0.X.0)</details>
<details>
<summary>🧰 Tools</summary>
<details>
<summary>🪛 markdownlint-cli2 (0.21.0)</summary>
[warning] 79-79: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
</details>
</details>
<details>
<summary>🤖 Prompt for AI Agents</summary>
Verify each finding against the current code and only fix it if needed.
In @.claude/skills/iii-patterns.md around lines 79 - 81, Update the fenced code
block so it includes a language specifier (use "text") to satisfy the markdown
linter; locate the fence containing the line "chore: bump versions for release
-- iii(iii/v0.X.0)" and change the opening triple backticks to "```text" so the
block is treated as plain text by the linter.
</details>
<!-- fingerprinting:phantom:triton:puma -->
<!-- This is an auto-generated comment by CodeRabbit -->
2 participants
Summary
CLAUDE.mdwith project guidance for Claude Code: build/test/lint commands, monorepo architecture, dependency chain, engine ports, release process, and conventions.claude/skills/iii-patterns.mdwith coding patterns extracted from git history analysis (200 commits).claude/instincts/for continuous learning: commit conventions, cross-SDK sync, engine module pattern, install script sync, and Biome formattingTest plan
Summary by CodeRabbit