Skip to content

docs: Add CLAUDE.md with build, lint, test commands and architecture overview.#2230

Open
wraymo wants to merge 1 commit intoy-scope:mainfrom
wraymo:add-claude-md
Open

docs: Add CLAUDE.md with build, lint, test commands and architecture overview.#2230
wraymo wants to merge 1 commit intoy-scope:mainfrom
wraymo:add-claude-md

Conversation

@wraymo
Copy link
Copy Markdown
Contributor

@wraymo wraymo commented Apr 29, 2026

Description

Adds a CLAUDE.md file at the repo root. This file is automatically loaded by Claude Code when working in this repository, giving the AI assistant immediate context about how to build, lint, and test the project without needing to search through the codebase.

The file covers:

  • Initial setup steps (submodule init, native dep installation)
  • Build commands (task, task core, task rust, task webui, package tars)
  • Lint commands (full vs. diff C++ passes, per-language tools)
  • Test commands (integration test tasks, single-file pytest invocation, pytest marks, Rust tests)
  • A component table and runtime service architecture overview
  • The two storage/query engine flavors (clp-text vs clp-json)

Checklist

  • The PR satisfies the contribution guidelines.
  • This is a breaking change and that has been indicated in the PR title, OR this isn't a breaking change.
  • Necessary docs have been updated, OR no docs need to be updated.

Validation performed

Manually verified all commands against the taskfiles and dev docs in docs/src/dev-docs/.

Summary by CodeRabbit

  • Documentation
    • Added comprehensive developer documentation covering monorepo setup, build workflows, testing procedures, lint standards, architecture overview, service infrastructure, and storage engine configuration.

…overview.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Apr 29, 2026

Walkthrough

Introduces a new CLAUDE.md documentation file providing guidance on working with the monorepo. It covers dependency setup, build and clean targets, C++ parallelism configuration, lint and test workflows for multiple languages, architecture overview, runtime service model, storage engine variants, and key design points.

Changes

Cohort / File(s) Summary
Documentation
CLAUDE.md
New file documenting monorepo setup, build workflows, test procedures, architecture overview, runtime services, storage engine selection, and design considerations for Claude Code integration.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the primary change: adding a CLAUDE.md documentation file with comprehensive build, lint, test commands and architecture overview.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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
Review rate limit: 7/8 reviews remaining, refill in 7 minutes and 30 seconds.

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

@wraymo wraymo marked this pull request as ready for review April 29, 2026 13:43
@wraymo wraymo requested a review from a team as a code owner April 29, 2026 13:43
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: 1

🤖 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.md`:
- Line 100: Update the architecture table entry that currently uses
`log-viewer-webui` so it matches the actual submodule name `yscope-log-viewer`;
locate and replace the `log-viewer-webui` token in the CLAUDE.md table row with
`yscope-log-viewer` (ensuring the TypeScript/description cell remains unchanged)
so both the entry at Line 100 and the reference at Line 129 use the canonical
`yscope-log-viewer` name.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: ee626fa3-bf29-4b69-9e66-e549ef85b221

📥 Commits

Reviewing files that changed from the base of the PR and between aa28a0c and d141e29.

📒 Files selected for processing (1)
  • CLAUDE.md

Comment thread CLAUDE.md
| `clp-package-utils` | Python | CLI tools for operating the CLP package |
| `clp-mcp-server` | Python | MCP server exposing CLP search to AI assistants |
| `webui` | TypeScript/Node.js | Main web interface (client + server) |
| `log-viewer-webui` | TypeScript | Standalone log viewer (git submodule in webui) |
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Unify log viewer component naming to avoid contributor confusion.

Line 100 lists log-viewer-webui, while Line 129 refers to yscope-log-viewer as the actual submodule. Please use one canonical name in both places (preferably yscope-log-viewer) to keep the architecture table unambiguous.

Also applies to: 129-129

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@CLAUDE.md` at line 100, Update the architecture table entry that currently
uses `log-viewer-webui` so it matches the actual submodule name
`yscope-log-viewer`; locate and replace the `log-viewer-webui` token in the
CLAUDE.md table row with `yscope-log-viewer` (ensuring the
TypeScript/description cell remains unchanged) so both the entry at Line 100 and
the reference at Line 129 use the canonical `yscope-log-viewer` name.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant