Skip to content

Commit 789c95f

Browse files
committed
docs(CLAUDE.md): update project structure and build instructions
- Update project structure documentation to reflect new directory layout - Replace old `src/` structure with new `rust/` and `python/` organization - Add detailed breakdown of Rust core modules including graph, memo, metrics, events, and throttle components - Include information about Python SDK (PyO3 bindings) and docs site - Update build commands section with separate instructions for Rust core, Python SDK, and documentation site - Modify development workflow to include Python bindings updates
1 parent 49b3f7f commit 789c95f

1 file changed

Lines changed: 31 additions & 15 deletions

File tree

CLAUDE.md

Lines changed: 31 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -4,28 +4,43 @@ A hierarchical, reasoning-native document intelligence engine written in Rust.
44

55
## Project Structure
66

7-
- `src/` - Source code
8-
- `client/` - Client API
9-
- `core/` - Core types and traits
10-
- `document/` - Document parsers (Markdown, PDF, DOCX)
11-
- `indexer/` - Index building
12-
- `retriever/` - Retrievers (beam search, MCTS, hybrid)
13-
- `storage/` - Storage layer
14-
- `summarizer/` - Summary generation
15-
- `llm/` - LLM client
16-
- `benches/` - Benchmarks
17-
- `tests/` - Integration tests
18-
- `docs/` - Design documents
7+
- `rust/` - Rust core engine
8+
- `src/client/` - Client API (EngineBuilder, Engine)
9+
- `src/config/` - Configuration types
10+
- `src/document/` - Document parsers (Markdown, PDF)
11+
- `src/index/` - Index building and pipeline
12+
- `src/retrieval/` - Retrieval engine (beam search, MCTS, greedy, hybrid strategies)
13+
- `src/storage/` - Storage layer
14+
- `src/llm/` - LLM client abstraction
15+
- `src/graph/` - Cross-document relationship graph
16+
- `src/memo/` - Caching and reasoning memo
17+
- `src/metrics/` - Metrics and usage tracking
18+
- `src/events/` - Event system for progress monitoring
19+
- `src/throttle/` - Rate limiting
20+
- `src/utils/` - Utility functions
21+
- `examples/` - Rust examples (flow, indexing, pdf, batch, etc.)
22+
- `python/` - Python SDK (PyO3 bindings)
23+
- `docs/` - Docusaurus documentation site
1924
- `samples/` - Sample files
2025

2126
## Build Commands
2227

2328
```bash
29+
# Rust core
30+
cd rust
2431
cargo build # Build
2532
cargo test # Run tests
26-
cargo bench # Run benchmarks
2733
cargo clippy # Lint
2834
cargo fmt # Format code
35+
36+
# Python SDK
37+
cd python
38+
pip install -e . # Install in editable mode
39+
40+
# Docs site
41+
cd docs
42+
pnpm install # Install dependencies
43+
pnpm build # Build static site
2944
```
3045

3146
## Code Conventions
@@ -107,6 +122,7 @@ When uncertain whether an operation is safe, **default to asking user confirmati
107122

108123
## Common Development Workflow
109124

110-
1. **Adding features**: Implement in appropriate `src/` module, add tests
125+
1. **Adding features**: Implement in appropriate `rust/src/` module, add tests
111126
2. **Fixing bugs**: Add failing test case first, fix and ensure tests pass
112-
3. **Committing code**: Use semantic commit messages, format: `type(scope): description`
127+
3. **Python bindings**: Update `python/src/lib.rs` (PyO3) when Rust APIs change
128+
4. **Committing code**: Use semantic commit messages, format: `type(scope): description`

0 commit comments

Comments
 (0)