Skip to content

Add Claude.md#140

Merged
jherr merged 2 commits intomainfrom
fix/claudemd
Dec 13, 2025
Merged

Add Claude.md#140
jherr merged 2 commits intomainfrom
fix/claudemd

Conversation

@tannerlinsley
Copy link
Copy Markdown
Member

@tannerlinsley tannerlinsley commented Dec 11, 2025

🎯 Changes

✅ Checklist

  • I have followed the steps in the Contributing guide.
  • I have tested this code locally with pnpm run test:pr.

🚀 Release Impact

  • This change affects published code, and I have generated a changeset.
  • This change is docs/CI/dev-only (no release).

Summary by CodeRabbit

  • Documentation
    • Added comprehensive development documentation covering repository structure and organization, tooling setup with pnpm and Nx, TypeScript configuration, build and test procedures using Vitest, code quality tools (ESLint, Prettier), architectural concepts, adapter patterns, framework integrations, core file structure, development workflow, coding conventions, important dependencies, and practical implementation examples.

✏️ Tip: You can customize this high-level summary in your review settings.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Dec 11, 2025

Walkthrough

A new documentation file CLAUDE.md has been added, providing guidance for Claude Code within the repository. The document describes the monorepo structure, development tooling (pnpm, Nx, TypeScript, Vitest, ESLint, Prettier), core architecture concepts, and development workflows without introducing code changes.

Changes

Cohort / File(s) Summary
Documentation
CLAUDE.md
New file added describing repository overview, tooling, architecture, core file structure, adapter system, provider adapters, development workflow, conventions, dependencies, and usage examples.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

  • Single documentation file with no code changes
  • Content verification and accuracy check only
  • Straightforward informational additions

Poem

🐰 A guide for Claude to hop along,
Through Nx and tools, both right and strong,
Adapters, functions, types so true,
CLAUDE.md shows what to do! 📚✨

Pre-merge checks and finishing touches

❌ Failed checks (1 warning, 1 inconclusive)
Check name Status Explanation Resolution
Description check ⚠️ Warning The pull request description follows the template structure and required checklist items, but the Changes section is completely empty. Fill in the Changes section with a description of what Claude.md contains and why it was added to the repository.
Title check ❓ Inconclusive The title 'Add Claude.md' is vague and generic, providing minimal context about what Claude.md contains or its purpose. Consider using a more descriptive title like 'Add Claude.md with monorepo guidance' or 'Add Claude.md documentation for AI integration' to better convey the file's purpose.
✅ Passed checks (1 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch fix/claudemd

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

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 049eb8a and 79e5ffa.

📒 Files selected for processing (1)
  • CLAUDE.md (1 hunks)
🧰 Additional context used
🪛 LanguageTool
CLAUDE.md

[grammar] ~186-~186: Ensure spelling is correct
Context: ...in exports (chat, embedding, summarize, toolDefinition, etc.) - types.ts - Core type def...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

🪛 markdownlint-cli2 (0.18.1)
CLAUDE.md

84-84: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

🔇 Additional comments (1)
CLAUDE.md (1)

1-275: Documentation is comprehensive and well-structured.

The CLAUDE.md file provides clear, detailed guidance on the monorepo organization, tooling, common development workflows, and architectural patterns. The content is well-organized into logical sections with practical examples and is appropriately tailored for Claude Code. The documentation accurately reflects typical monorepo conventions (pnpm, Nx, workspace protocols, tree-shakeable exports) and should serve as a useful reference for development.

Comment thread CLAUDE.md
Comment on lines +84 to +112
```
packages/
├── typescript/ # TypeScript packages (main implementation)
│ ├── ai/ # Core AI library (@tanstack/ai)
│ ├── ai-client/ # Framework-agnostic chat client
│ ├── ai-react/ # React hooks (useChat)
│ ├── ai-solid/ # Solid hooks
│ ├── ai-svelte/ # Svelte integration
│ ├── ai-vue/ # Vue integration
│ ├── ai-openai/ # OpenAI adapter
│ ├── ai-anthropic/ # Anthropic/Claude adapter
│ ├── ai-gemini/ # Google Gemini adapter
│ ├── ai-ollama/ # Ollama adapter
│ ├── ai-devtools/ # DevTools integration
│ ├── react-ai-devtools/ # React DevTools component
│ └── solid-ai-devtools/ # Solid DevTools component
├── php/ # PHP packages (future)
└── python/ # Python packages (future)

examples/ # Example applications
├── ts-react-chat/ # React chat example
├── ts-solid-chat/ # Solid chat example
├── ts-vue-chat/ # Vue chat example
├── ts-svelte-chat/ # Svelte chat example
├── ts-group-chat/ # Multi-user group chat
├── vanilla-chat/ # Vanilla JS example
├── php-slim/ # PHP Slim framework example
└── python-fastapi/ # Python FastAPI example
```
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

Specify a language for the fenced code block.

Markdown linting requires fenced code blocks to have a language identifier. The monorepo structure block at line 84 is missing one. Since this is a tree structure (not executable code), consider using text as the language specifier.

Apply this diff to add the language specifier:

-```
+```text
 packages/
 ├── typescript/           # TypeScript packages (main implementation)
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)

84-84: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

🤖 Prompt for AI Agents
In CLAUDE.md around lines 84 to 112 the fenced code block showing the monorepo
tree lacks a language specifier, which violates Markdown linting; add the
language identifier `text` to the opening fence (i.e. change ``` to ```text) so
the block is recognized as plain text and the linter warning is resolved.

@jherr jherr merged commit e011bf8 into main Dec 13, 2025
2 checks passed
@jherr jherr deleted the fix/claudemd branch December 13, 2025 17:08
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.

2 participants