Skip to content

docs: weekly review 2026-04-30#112

Open
vasylenko wants to merge 2 commits intomainfrom
docs/weekly-review-2026-04-30
Open

docs: weekly review 2026-04-30#112
vasylenko wants to merge 2 commits intomainfrom
docs/weekly-review-2026-04-30

Conversation

@vasylenko
Copy link
Copy Markdown
Owner

Summary

Two factual inaccuracies were found during the weekly documentation review. The src/ source tree in CLAUDE.md still described the old flat layout, while the code has been reorganized into infra/, operations/, and tools/ subdirectories. Additionally, SPECIFICATION.md incorrectly attributed the decodeTagName() TypeScript function to tags.ts; it was extracted to bear-encoding.ts during a refactor.

Changes

  • SPECIFICATION.md: Tag decoding TypeScript function location wrong → changed tags.ts to bear-encoding.ts in the "Tag name decoding logic exists in two places" sentence under Bear's Database constraints. Confirmed by the in-code comment in src/operations/notes.ts which already points to the correct file.
  • CLAUDE.md: src/ project structure tree outdated → replaced flat layout with the actual layered structure (infra/, operations/, tools/ subdirectories); removed the no-longer-existing utils.ts; added logging.ts, bear-encoding.ts, and responses.ts; updated main.ts description (tool registration moved to src/tools/).

No Issues Found

  • README.md: Tool list (12 tools), Node.js version requirement (24.13.0+), installation instructions, configuration env vars, and log file paths all accurate.
  • docs/user/NPM.md: Tool list, Node.js requirement, configuration table, and quick-start commands all accurate.
  • docs/dev/SECURITY.md: Trust model, defense rules, and security principles all accurate and consistent with implementation.
  • docs/dev/BEAR_DATABASE_SCHEMA.md: Schema definitions, database path, and query patterns match codebase.
  • SPECIFICATION.md (all other sections): Architecture diagram, fire-and-forget model, safety gates, error handling contract, and testing constraints all accurate.
  • Cross-document consistency: Tool count (12), Node.js version, env var names, and database path are consistent across all documents.

Generated by Claude Code

The spec referenced `tags.ts` as the location of the `decodeTagName()`
TypeScript function, but it was extracted to `bear-encoding.ts` during
a refactor. The in-code comment in `notes.ts` already points to the
correct location: `operations/bear-encoding.ts`.
The source tree was refactored into layered subdirectories (infra/,
operations/, tools/) but the Project Structure section still showed the
old flat layout. Also removes the no-longer-existing utils.ts entry and
adds the new logging.ts, bear-encoding.ts, and tools/ entries.
Copilot AI review requested due to automatic review settings April 30, 2026 00:11
@vercel
Copy link
Copy Markdown

vercel Bot commented Apr 30, 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 Apr 30, 2026 0:11am

@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 documentation to match the current TypeScript source layout and recent refactors, ensuring file references in docs align with the reorganized src/ tree.

Changes:

  • Corrects SPECIFICATION.md to reference decodeTagName()’s current location (bear-encoding.ts).
  • Updates CLAUDE.md’s project structure diagram to reflect the layered src/infra/, src/operations/, and src/tools/ organization (and current filenames).

Reviewed changes

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

File Description
docs/dev/SPECIFICATION.md Fixes the documented location of the tag decoding function to match the current code.
CLAUDE.md Updates the src/ tree diagram to reflect the current directory structure and key files.

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