Skip to content

docs: weekly review 2026-05-21#130

Open
vasylenko wants to merge 1 commit into
mainfrom
docs/weekly-review-2026-05-21
Open

docs: weekly review 2026-05-21#130
vasylenko wants to merge 1 commit into
mainfrom
docs/weekly-review-2026-05-21

Conversation

@vasylenko
Copy link
Copy Markdown
Owner

Summary

The weekly documentation review found one factual inaccuracy in CLAUDE.md: the Source Layout section listed "filesystem" as an external system adapter living in src/infra/, but no such adapter exists there. The filesystem access for bear-add-file (readAttachmentFile) is implemented inline in src/tools/note-tools.ts. The only external system adapters in src/infra/ are the SQLite adapter (database.ts) and the Bear URL scheme adapter (bear-urls.ts).

Changes

  • CLAUDE.md — Source Layout section claimed (SQLite, filesystem, Bear URL scheme) adapters live in infra/; removed filesystem from the list since no filesystem adapter exists in src/infra/ (readAttachmentFile is in src/tools/note-tools.ts)

No Issues Found

The following checklist areas were verified accurate:

  • Reference Accuracy: All referenced files, constants, and file paths match the codebase (e.g., REVISION_POLL_TARGET_MS, POLL_TIMEOUT_MS, database.ts:59, system test at tests/system/registration-gate.test.ts, src/infra/bear-schema.test.ts FTS5 guard)
  • Configuration Options: All three env vars (UI_DEBUG_TOGGLE, UI_ENABLE_NEW_NOTE_CONVENTION, UI_ENABLE_CONTENT_REPLACEMENT) correctly documented in README.md, NPM.md, manifest.json, and website
  • Feature Behavior Descriptions: Tool count (4 read + 8 write), file attachment limit (25 MB), BM25 weights (2.0/2.0/0.5), snippet sizes (80-token FTS5 / 200-char filter-only), OCC polling behavior all match code
  • Installation and Setup: Node.js version requirement (24.13.0+) matches package.json; install commands verified; database path (~/Library/Group Containers/...) matches database.ts
  • Architecture Spec: READ/WRITE path diagram, layer boundaries, FTS5 index behavior, OCC inform/enforce split all match implementation
  • Cross-Document Consistency: Tool counts, env var names, and Node version are consistent across README.md, NPM.md, CLAUDE.md, manifest.json, and website components

Generated by Claude Code

…fra adapters list

The filesystem access for bear-add-file (readAttachmentFile) is implemented
inline in src/tools/note-tools.ts, not as a separate adapter in src/infra/.
The only external system adapters in src/infra/ are SQLite (database.ts) and
the Bear URL scheme (bear-urls.ts).
Copilot AI review requested due to automatic review settings May 21, 2026 00:14
@vercel
Copy link
Copy Markdown

vercel Bot commented May 21, 2026

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

Project Deployment Actions Updated (UTC)
bear-notes-mcp Ready Ready Preview, Comment May 21, 2026 12:14am

@vasylenko
Copy link
Copy Markdown
Owner Author

vasylenko commented May 21, 2026

Snyk checks have passed. No issues have been found so far.

Status Scan Engine Critical High Medium Low Total (0)
Open Source Security 0 0 0 0 0 issues
Code Security 0 0 0 0 0 issues

💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse.

@sonarqubecloud
Copy link
Copy Markdown

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates project documentation to remove an incorrect claim about a non-existent filesystem adapter in src/infra/, keeping the architecture overview aligned with the actual codebase structure.

Changes:

  • Removed “filesystem” from the list of external-system adapters purported to live in src/infra/ in CLAUDE.md.

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