Skip to content

Expand CLAUDE.md with architecture and the just workflow#52

Merged
gmr merged 1 commit into
mainfrom
chore/justfile
Jun 16, 2026
Merged

Expand CLAUDE.md with architecture and the just workflow#52
gmr merged 1 commit into
mainfrom
chore/justfile

Conversation

@gmr

@gmr gmr commented Jun 16, 2026

Copy link
Copy Markdown
Owner

Rewrite the brief project notes into a fuller guide: the standard Claude Code preamble, the command/architecture/testing sections, the parity-oracle note, and the key directories. Commands now point at the Justfile recipes (just build/check/fmt/lint/test, the db and gate recipes) added alongside this change.

Summary by CodeRabbit

  • Documentation
    • Updated internal developer documentation with expanded guidance on repository structure, command utilities, CLI architecture, integration testing procedures, and key directory references.

Rewrite the brief project notes into a fuller guide: the standard
Claude Code preamble, the command/architecture/testing sections, the
parity-oracle note, and the key directories. Commands now point at the
Justfile recipes (just build/check/fmt/lint/test, the db and gate
recipes) added alongside this change.

Co-authored-by: Claude <noreply@anthropic.com>
@gmr gmr merged commit 18d9b1c into main Jun 16, 2026
1 check was pending
@gmr gmr deleted the chore/justfile branch June 16, 2026 18:23
@coderabbitai

coderabbitai Bot commented Jun 16, 2026

Copy link
Copy Markdown

Review Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: e80f3e44-cb05-4a50-83d0-d4662781b829

📥 Commits

Reviewing files that changed from the base of the PR and between f509a5d and 7db6d07.

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

📝 Walkthrough

Walkthrough

CLAUDE.md is fully rewritten from a brief Rust-rewrite guide into a comprehensive Claude-targeted reference covering repository purpose, just/cargo commands, CLI architecture (subcommands, shared layers, crates), a parity-oracle section referencing the python-final tag, integration test gate instructions using compose.yaml, and an expanded Key Directories list.

Changes

CLAUDE.md Documentation Rewrite

Layer / File(s) Summary
CLAUDE.md full content replacement
CLAUDE.md
Replaces 21-line Rust-rewrite notes with 115-line guide covering repository overview, just/cargo commands, CLI subcommand and shared-layer architecture, parity-oracle instructions against the python-final tag, PostgreSQL gate setup via compose.yaml, and an updated Key Directories section.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐇 A dusty old scroll, now refreshed and new,
With gates and oracles and commands in view,
The just recipes listed, the parity clear,
Directories mapped for the coder to steer —
Hippity-hop, the docs finally cheer! 🌿

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chore/justfile

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

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