Repository navigation
docs: CLAUDE.md files, README and docs intros lead with the vision - #234
Merged
Merged
Conversation
…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>
|
Warning Review limit reachedNext included review available in 34 minutes. View limit detailsLimit 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. Review configuration: ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Advanced Run ID: 📒 Files selected for processing (6)
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. Comment |
… 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>
…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>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
CLAUDE.md and the README now open with where B2 is going instead of how it was built.
CLAUDE.md (276 → 160 lines)
supports/contradicts), answers I can check (search that admits when it has no evidence, and cited chat), and agents as users (--json).observedissues, and changes are measured before tuning.VaultAPI list (which was already missing about 10 functions).README (180 → 115 lines)
Desktop CLAUDE.md (453 → 133 lines)
observedissues will land here.:focusvs:focus-visible, WebKit not focusing a clicked button, menu shortcuts never reaching the webview (⌘⇧= doesn't zoom), and the memoized overlay layer.Docs intros and platform
docs/README.mdanddocs/architecture.mdopen with the same research framing.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 pathB2_LOG_FILEneeds undermake app; the correctb2=debugdefault; 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 checkpasses. The README examples were run against the golden vault.🤖 Generated with Claude Code