Skip to content

docs: weekly review 2026-05-28#132

Merged
vasylenko merged 1 commit into
mainfrom
docs/weekly-review-2026-05-28
May 28, 2026
Merged

docs: weekly review 2026-05-28#132
vasylenko merged 1 commit into
mainfrom
docs/weekly-review-2026-05-28

Conversation

@vasylenko
Copy link
Copy Markdown
Owner

Summary

One inaccuracy found in developer-facing docs: CODE_STYLE.md referenced task check and task format — neither of which exists in Taskfile.yml. Developers following these instructions would get a "task not found" error. Fixed to use the correct commands: npm run check (validates lint + format without modifying files) and task style (applies lint + format fixes, which is the existing task in Taskfile.yml).

Changes

  • docs/dev/CODE_STYLE.md: task checknpm run check, task formattask style — stale task names replaced with commands that actually exist

No Issues Found

  • Reference Accuracy: All file paths, module names, and tool names in docs match the codebase
  • Configuration Options: All three env vars (UI_DEBUG_TOGGLE, UI_ENABLE_NEW_NOTE_CONVENTION, UI_ENABLE_CONTENT_REPLACEMENT) verified against src/logging.ts and src/config.ts
  • Feature Behavior Descriptions: Tool counts (4 read-only + 8 write + 1 discovery), gating behavior, OCC revision flow, and FTS5 search description all match the implementation
  • Installation and Setup: Node.js ^24.13.0 requirement matches package.json engines field; installation commands verified
  • Architecture Spec: Layered infra → operations → tools structure, hybrid read (SQLite) / write (x-callback-url) model, registration-time gating via applyWriteGate, and all referenced source files confirmed present
  • Cross-Document Consistency: Tool lists in README.md and docs/user/NPM.md are consistent; env var names match across all docs and source

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 via lint + format).
Copilot AI review requested due to automatic review settings May 28, 2026 00:14
@vercel
Copy link
Copy Markdown

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

@vasylenko
Copy link
Copy Markdown
Owner Author

vasylenko commented May 28, 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 developer-facing style documentation to reference the actual lint/format commands available in the repo, preventing “task not found” workflow errors.

Changes:

  • Replace stale task check reference with npm run check (non-fixing validation).
  • Replace stale task format references with task style (applies eslint + prettier fixes).

@vasylenko vasylenko merged commit 891ddcf into main May 28, 2026
13 of 16 checks passed
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