Skip to content

docs: weekly review 2026-05-14#126

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

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

Conversation

@vasylenko
Copy link
Copy Markdown
Owner

Summary

Weekly documentation audit against the current codebase (main @ 8ddf229). All user-facing docs (README.md, docs/user/NPM.md) and maintainer-facing docs (CLAUDE.md, docs/dev/SPECIFICATION.md, docs/dev/SECURITY.md, docs/dev/MCP_STANDARDS.md, docs/dev/CODE_STYLE.md) were reviewed. One inaccuracy was found and fixed: docs/dev/CODE_STYLE.md referenced two task commands (task check, task format) that do not exist in Taskfile.yml.

Changes

  • docs/dev/CODE_STYLE.md — stale task command references fixed: The file told developers to run task check to validate and task format to auto-fix style. Neither task exists in Taskfile.yml. The correct commands are npm run check (runs eslint + prettier check) and task style (runs npm run lint + npm run format to fix). Both references updated accordingly.

No Issues Found

The following checklist areas were verified and found accurate:

  • Reference Accuracy — all file paths cited in docs (e.g. tests/system/registration-gate.test.ts, website/src/components/FeatureGrid.astro, InstallGuide.astro, FAQ.astro, src/config.ts:10) exist and match.
  • Configuration Options — all three env vars (UI_DEBUG_TOGGLE, UI_ENABLE_NEW_NOTE_CONVENTION, UI_ENABLE_CONTENT_REPLACEMENT) correctly named and described across README, NPM.md, manifest.json, and source code.
  • Feature Behavior — tool counts (4 always-on read tools, 8 write tools behind Edit Mode gate, bear-capabilities conditionally registered only when gate is closed), 25 MB attachment cap, file/symlink rejection, date filter descriptions, and pinned-note filter all match implementation.
  • Installation and Setup — Node.js ^24.13.0 requirement consistent across package.json, manifest.json, README, and NPM.md; Claude Code and generic MCP install commands verified accurate.
  • Architecture Spec — layered infra → operations → tools dependency flow, hybrid SQLite-read / x-callback-url-write model, in-memory FTS5 index drift-check logic, registration-time write gating, and pre-flight validation scope all match the codebase.
  • Cross-Document Consistency — tool counts, env var names, and Node.js version requirement are stated identically across all docs that mention them.

Generated by Claude Code

`task check` and `task format` do not exist in Taskfile.yml.
The correct commands are `npm run check` (validate) and `task style` (auto-fix).
Copilot AI review requested due to automatic review settings May 14, 2026 00:13
@vercel
Copy link
Copy Markdown

vercel Bot commented May 14, 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 14, 2026 0:13am

@vasylenko
Copy link
Copy Markdown
Owner Author

vasylenko commented May 14, 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 maintainer documentation to correct stale task command references in the code style guide, aligning contributor instructions with the current Taskfile.yml and package.json scripts.

Changes:

  • Replaced nonexistent task check/task format references with npm run check and task style.
  • Updated the formatting section to reference task style for applying fixes.

Comment thread docs/dev/CODE_STYLE.md
# Code Style

Most style is auto-enforced by tsconfig + eslint + prettier — run `task check` to validate, `task format` to auto-fix. This file captures the project-specific choices and the conventions to follow when tooling doesn't speak up.
Most style is auto-enforced by tsconfig + eslint + prettier — run `npm run check` to validate, `task style` to auto-fix. This file captures the project-specific choices and the conventions to follow when tooling doesn't speak up.
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