Skip to content

docs: CLAUDE.md files, README and docs intros lead with the vision - #234

Merged
samkeen merged 3 commits into
mainfrom
docs/claude-md-vision
Sep 23, 2026
Merged

samkeen merged 3 commits into
mainfrom
docs/claude-md-vision

Conversation

@samkeen

@samkeen samkeen commented Sep 23, 2026 •

Copy link
Copy Markdown
Contributor

CLAUDE.md and the README now open with where B2 is going instead of how it was built.

CLAUDE.md (276 → 160 lines)

  • What B2 is for: my daily notes app, replacing Obsidian, built to be a better research tool. Four things it adds, all already shipped: finding links I haven't made (with Why?), typed stance (supports/contradicts), answers I can check (search that admits when it has no evidence, and cited chat), and agents as users (--json).
  • Where we are, and how work starts: the build-out is done. Work now starts from observed issues, and changes are measured before tuning.
  • Kept: the two core ideas, the principles, the gates, the testing rules and the Rust style rules.
  • Replaced by pointers: the env var reference, the crate internals, the four flows, and the Vault API list (which was already missing about 10 functions).

README (180 → 115 lines)

  • Reads as: what B2 is for, what it does, what it promises, status, get started, how it's built, docs, develop.
  • Drops the build-out status block ("the chat pane is next", "next: file-type support") and the Obsidian-style frontmatter that GitHub renders as a table.

Desktop CLAUDE.md (453 → 133 lines)

  • Opens with what the app is for: where B2 is used every day, a good editor first, with the research tools beside the note. Most observed issues will land here.
  • Keeps the rules (dumb adapter, the four keyboard obligations, the single sanitizing render path, drag and drop), each stated once.
  • Keeps the traps that aren't written down anywhere else: repaints destroy focus, :focus vs :focus-visible, WebKit not focusing a clicked button, menu shortcuts never reaching the webview (⌘⇧= doesn't zoom), and the memoized overlay layer.
  • Leaves per-module reasoning to each module's header comment, which already covers it.

Docs intros and platform

  • docs/README.md and docs/architecture.md open with the same research framing.
  • The quick start said macOS and Linux are tested, but CI runs only on macOS. The quick start and the README now both say macOS is the one tested platform.

Nothing lost. Detail that only lived in CLAUDE.md or the README moved into the docs first:

  • docs/quickstart.md: B2_LLM_MAX_TOOL_CALLS; the absolute path B2_LOG_FILE needs under make app; the correct b2=debug default; the Node version floor; the Metal-vs-CPU note.
  • docs/architecture.md: the Why? tool turn. "Not yet built", which still named the reranker as next, becomes "What comes next".

make check passes. The README examples were run against the golden vault.

🤖 Generated with Claude Code

…acement) and points to the docs for the rest

CLAUDE.md read like the build-out phase: long on mechanics, silent on where
B2 is going. It now opens with what B2 is for (my daily notes app, replacing
Obsidian, built to be a better research tool), the two ideas to protect, and
how work starts now (from `observed` issues after the 2026-09-23 backlog reset).

The detail that duplicated the docs is replaced by pointers. The stale `Vault`
API list is gone (vault.rs is the list). What only CLAUDE.md said moved into
the docs first, so nothing is lost:

- quickstart: `B2_LLM_MAX_TOOL_CALLS`; `B2_LOG_FILE` wants an absolute path
  under `make app`; `B2_DEBUG`/`B2_LOG_FILE` imply `b2=debug`, not `debug`
  (the code's actual default).
- architecture: the Why? tool-using turn in flow 4; "Not yet built" (which
  still named the reranker as next) becomes "What comes next".

276 lines to 160.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Sep 23, 2026 •

Copy link
Copy Markdown

Warning

Review limit reached

Next included review available in 34 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used the included review currently available.

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Learn how review limits work.

Review configuration:

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Advanced

Run ID: 71c8a46d-05d3-4eca-a446-7f8059339e9a

📥 Commits

Reviewing files that changed from the base of the PR and between c1c06ea and e364ff2.

📒 Files selected for processing (6)
  • CLAUDE.md
  • README.md
  • crates/b2-desktop/CLAUDE.md
  • docs/README.md
  • docs/architecture.md
  • docs/quickstart.md

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.

… what it does today

The README opened with a 35-line status block from the build-out (steps 0 to 5,
"the chat pane is next", "next: file-type support") and Obsidian-style
frontmatter that GitHub renders as a table. It now reads top to bottom as:
what B2 is for, what it does, what it promises, status (use-driven, #23 for an
installable build), get started, how it's built, docs, develop.

Setup detail it dropped moved to the quick start first: the Node version floor
and Tauri CLI install, and the Metal-vs-CPU note for `make app`.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
samkeen added a commit that referenced this pull request Sep 23, 2026
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@samkeen samkeen changed the title docs: CLAUDE.md leads with the vision, points to the docs for detail docs: CLAUDE.md and README lead with the vision (a notes app for research) Sep 23, 2026
…orm wording align

crates/b2-desktop/CLAUDE.md (453 to 133 lines) now opens with what the app
is for: the daily place B2 is used, a good editor first and a research tool
beside it, where most `observed` issues will land. The rules stay (dumb
adapter, K1's four obligations, E5's single sanitizing path, drag and drop),
stated once each. Per-module reasoning is left to each module's header
comment, which already carries it. The traps that are not written down
anywhere else stay here: repaint destroys focus, `:focus` vs `:focus-visible`,
WebKit not focusing a clicked button, menu accelerators never reaching the
webview (and ⌘⇧= not zooming), and the memoized overlay layer. The pointer to
the closed `serve` issue (#24) is gone.

docs/README.md and docs/architecture.md open with the research framing the
root README now uses. The quick start claimed macOS and Linux are tested;
CI runs only on macOS, so it and the README now say macOS is the one tested
platform.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@samkeen samkeen changed the title docs: CLAUDE.md and README lead with the vision (a notes app for research) docs: CLAUDE.md files, README and docs intros lead with the vision Sep 23, 2026
@samkeen
samkeen merged commit b5c0fde into main Sep 23, 2026
2 checks passed
@samkeen
samkeen deleted the docs/claude-md-vision branch September 23, 2026 15:54
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