Skip to content

chore(claude-md): slim CLAUDE.md, move deep-dives into docs/#806

Closed
jwalin-shah wants to merge 1 commit intotinyhumansai:mainfrom
jwalin-shah:chore/claude-md-slim
Closed

chore(claude-md): slim CLAUDE.md, move deep-dives into docs/#806
jwalin-shah wants to merge 1 commit intotinyhumansai:mainfrom
jwalin-shah:chore/claude-md-slim

Conversation

@jwalin-shah
Copy link
Copy Markdown
Contributor

Summary

Extracts three long reference sections from `CLAUDE.md` into dedicated docs so they load on-demand instead of on every Claude Code session start. No content changes — same prose, new location.

Moved

Kept in CLAUDE.md

Still useful as always-loaded overview:

  • Repo layout, commands, runtime scope, configuration
  • Frontend quick map (provider chain, state, services, routes)
  • Tauri shell overview
  • Rust core key rules (controller-only exposure, light `mod.rs`, subdir layout) — brief form, pointer to full detail
  • Coding philosophy, key patterns, git workflow

Size impact

  • `CLAUDE.md`: 32.8k → 13.3k chars (~8.2k → ~3.3k tokens)
  • Session context saving for contributors using Claude Code: ~5k tokens per session
  • Contributors reading the repo in a normal editor lose nothing — pointers at the top link to the extracted docs.

Relation to other PRs

Complements #804 (`paths:` frontmatter for `.claude/rules/`) and issue #805 (rules audit). Together they target ~30-40k token savings per Claude Code session startup.

Test plan

  • `docs/TESTING.md`, `docs/event-bus.md`, `docs/feature-workflow.md` render correctly on GitHub
  • All cross-references in the new docs resolve (relative paths)
  • Links from `CLAUDE.md` to the new docs resolve
  • No content was dropped — search `git log -p main..HEAD -- CLAUDE.md` to confirm every removed paragraph landed in one of the three new docs

Extracts three long reference sections into dedicated docs so they load
on-demand instead of on every Claude Code session start. No content
changes — same prose, new location.

Moved:
- Testing guide (unit + E2E + mock backend + Rust tests) → docs/TESTING.md
- Event bus deep-dive (DomainEvent + NativeRegistry) → docs/event-bus.md
- Feature workflow + debug logging + controller migration + platform
  notes → docs/feature-workflow.md

Kept in CLAUDE.md (still useful as always-loaded overview):
- Repo layout, commands, runtime scope, configuration
- Frontend quick map (provider chain, state, services, routes)
- Tauri shell overview
- Rust core key rules (controller-only exposure, light mod.rs, subdir
  layout) — still reference-level for agents, kept in brief form
- Coding philosophy, key patterns, git workflow

Size: CLAUDE.md goes from 32.8k chars to 13.3k chars. Net session
context saving for contributors using Claude Code is ~5k tokens per
session. Contributors reading the repo in a normal editor lose nothing
— pointers at the top link to the extracted docs.
@jwalin-shah jwalin-shah requested a review from a team April 22, 2026 19:22
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Apr 22, 2026

Warning

Rate limit exceeded

@jwalin-shah has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 28 minutes and 51 seconds before requesting another review.

Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 28 minutes and 51 seconds.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 92131ad8-1576-4062-a0c7-40370fb1d65f

📥 Commits

Reviewing files that changed from the base of the PR and between b3b451f and b19def6.

📒 Files selected for processing (4)
  • CLAUDE.md
  • docs/TESTING.md
  • docs/event-bus.md
  • docs/feature-workflow.md
✨ 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

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

jwalin-shah pushed a commit to jwalin-shah/openhuman that referenced this pull request Apr 23, 2026
Two implementation plans drafted from the life-capture spec:

- Track 1 (ship pipeline): fix Ubuntu installer smoke, land in-flight PRs
  tinyhumansai#806/tinyhumansai#786/tinyhumansai#788/tinyhumansai#797, wire Tauri auto-updater + signed Mac/Windows builds.
- Life-Capture #1 (foundation): SQLite + sqlite-vec personal_index.db,
  Embedder trait + HostedEmbedder (OpenAI), PII redaction, quoted-thread
  stripping, hybrid retrieval (vector + keyword + recency), controller
  schema + RPC. End-to-end test with synthetic items. No ingestion or UI
  yet — those are subsequent milestone plans.
@jwalin-shah
Copy link
Copy Markdown
Contributor Author

Superseded — main has independently absorbed similar slim/structured CLAUDE.md changes since this PR was opened. Closing rather than rebasing through CLAUDE.md conflicts. The downstream stack (#817, #818) has been rebased to drop this commit.

jwalin-shah pushed a commit to jwalin-shah/openhuman that referenced this pull request Apr 23, 2026
Two implementation plans drafted from the life-capture spec:

- Track 1 (ship pipeline): fix Ubuntu installer smoke, land in-flight PRs
  tinyhumansai#806/tinyhumansai#786/tinyhumansai#788/tinyhumansai#797, wire Tauri auto-updater + signed Mac/Windows builds.
- Life-Capture #1 (foundation): SQLite + sqlite-vec personal_index.db,
  Embedder trait + HostedEmbedder (OpenAI), PII redaction, quoted-thread
  stripping, hybrid retrieval (vector + keyword + recency), controller
  schema + RPC. End-to-end test with synthetic items. No ingestion or UI
  yet — those are subsequent milestone plans.
jwalin-shah pushed a commit to jwalin-shah/openhuman that referenced this pull request Apr 23, 2026
Two implementation plans drafted from the life-capture spec:

- Track 1 (ship pipeline): fix Ubuntu installer smoke, land in-flight PRs
  tinyhumansai#806/tinyhumansai#786/tinyhumansai#788/tinyhumansai#797, wire Tauri auto-updater + signed Mac/Windows builds.
- Life-Capture #1 (foundation): SQLite + sqlite-vec personal_index.db,
  Embedder trait + HostedEmbedder (OpenAI), PII redaction, quoted-thread
  stripping, hybrid retrieval (vector + keyword + recency), controller
  schema + RPC. End-to-end test with synthetic items. No ingestion or UI
  yet — those are subsequent milestone plans.
jwalin-shah pushed a commit to jwalin-shah/openhuman that referenced this pull request Apr 23, 2026
Two implementation plans drafted from the life-capture spec:

- Track 1 (ship pipeline): fix Ubuntu installer smoke, land in-flight PRs
  tinyhumansai#806/tinyhumansai#786/tinyhumansai#788/tinyhumansai#797, wire Tauri auto-updater + signed Mac/Windows builds.
- Life-Capture #1 (foundation): SQLite + sqlite-vec personal_index.db,
  Embedder trait + HostedEmbedder (OpenAI), PII redaction, quoted-thread
  stripping, hybrid retrieval (vector + keyword + recency), controller
  schema + RPC. End-to-end test with synthetic items. No ingestion or UI
  yet — those are subsequent milestone plans.
@jwalin-shah jwalin-shah deleted the chore/claude-md-slim branch April 23, 2026 21:24
jwalin-shah pushed a commit to jwalin-shah/openhuman that referenced this pull request Apr 25, 2026
Two implementation plans drafted from the life-capture spec:

- Track 1 (ship pipeline): fix Ubuntu installer smoke, land in-flight PRs
  tinyhumansai#806/tinyhumansai#786/tinyhumansai#788/tinyhumansai#797, wire Tauri auto-updater + signed Mac/Windows builds.
- Life-Capture #1 (foundation): SQLite + sqlite-vec personal_index.db,
  Embedder trait + HostedEmbedder (OpenAI), PII redaction, quoted-thread
  stripping, hybrid retrieval (vector + keyword + recency), controller
  schema + RPC. End-to-end test with synthetic items. No ingestion or UI
  yet — those are subsequent milestone plans.
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