docs: weekly review 2026-04-23

[vasylenko]

Summary

Three inaccuracies found and fixed during the weekly documentation review. The CLAUDE.md project structure tree was missing two directories that exist in the repo (docs/ and evals/), with docs/ being particularly notable since it's explicitly referenced later in the same file. The BEAR_DATABASE_SCHEMA.md had a stale "Query Patterns" section showing a text-only search as the current implementation, when the actual code (notes.ts) always performs OCR file search via a LEFT JOIN on ZSFNOTEFILE; it also listed OCR file search and date range queries as unimplemented opportunities, but both are already implemented.

Changes

• CLAUDE.md project structure tree missing docs/ and evals/ → Added both directories with accurate descriptions. docs/ contains dev/ (SPECIFICATION.md, BEAR_DATABASE_SCHEMA.md, SECURITY.md) and user/ (NPM.md); evals/ is the promptfoo-based LLM evaluation suite.
• BEAR_DATABASE_SCHEMA.md "Current Implementation (Text Only)" query pattern is stale → Removed the text-only query subsection and renamed "Enhanced with File Search" to "Current Implementation (with OCR File Search)" to reflect that notes.ts always joins ZSFNOTEFILE for OCR search.
• BEAR_DATABASE_SCHEMA.md "Opportunities for Enhancement" lists already-implemented features → Removed the "Immediate (File Search)" subsection (OCR search via ZSEARCHTEXT is implemented) and the "Date Range Queries" item (date filtering via createdAfter/createdBefore/modifiedAfter/modifiedBefore is implemented in notes.ts).

No Issues Found

• README.md: Tool count (12), Node.js version requirement (24.13.0+), all configuration env vars (UI_DEBUG_TOGGLE, UI_ENABLE_NEW_NOTE_CONVENTION, UI_ENABLE_CONTENT_REPLACEMENT), installation instructions, log file paths, and date filter examples all accurate.
• docs/user/NPM.md: Node.js requirement, tool list, configuration table, and Quick Start commands all accurate.
• docs/dev/SPECIFICATION.md: Database path, BEAR_DB_PATH env var override, fire-and-forget write model, note creation polling timeout (2s), safety gates, and error handling contract all match the codebase.
• docs/dev/SECURITY.md: Trust model, defense rules (parameterized queries, spawn with argv array, URLSearchParams, zod schemas), and security principles all match the codebase.
• website/src/components/FeatureGrid.astro: Tool count ("12 tools") matches the 12 registered tools in main.ts.
• Cross-document consistency: Tool count and env var names are consistent across README.md, docs/user/NPM.md, manifest.json, and src/config.ts.

---

Generated by Claude Code

[vercel]

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Actions	Updated (UTC)
bear-notes-mcp	Ready	Preview, Comment	Apr 23, 2026 0:30am

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[Copilot]

Pull request overview

Updates developer documentation to reflect the repository’s actual structure and current SQL query behavior in the Bear search implementation.

Changes:

• Fixes the CLAUDE.md project structure tree to include docs/ and evals/.
• Updates docs/dev/BEAR_DATABASE_SCHEMA.md “Query Patterns” to reflect that searches include OCR file content via ZSFNOTEFILE.
• Removes “Opportunities for Enhancement” items that are already implemented (OCR file search and date range filters).

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File	Description
docs/dev/BEAR_DATABASE_SCHEMA.md	Corrects the documented “current implementation” search pattern and prunes already-implemented “enhancement” items.
CLAUDE.md	Updates the project structure tree to include docs/ and evals/.