docs: weekly review 2026-05-14#126
Open
vasylenko wants to merge 1 commit into
Open
Conversation
`task check` and `task format` do not exist in Taskfile.yml. The correct commands are `npm run check` (validate) and `task style` (auto-fix).
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Owner
Author
✅ Snyk checks have passed. No issues have been found so far.
💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse. |
|
Contributor
There was a problem hiding this comment.
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 formatreferences withnpm run checkandtask style. - Updated the formatting section to reference
task stylefor applying fixes.
| # 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. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.



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.mdreferenced twotaskcommands (task check,task format) that do not exist inTaskfile.yml.Changes
docs/dev/CODE_STYLE.md— stale task command references fixed: The file told developers to runtask checkto validate andtask formatto auto-fix style. Neither task exists inTaskfile.yml. The correct commands arenpm run check(runs eslint + prettier check) andtask style(runsnpm run lint+npm run formatto fix). Both references updated accordingly.No Issues Found
The following checklist areas were verified and found accurate:
tests/system/registration-gate.test.ts,website/src/components/FeatureGrid.astro,InstallGuide.astro,FAQ.astro,src/config.ts:10) exist and match.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.bear-capabilitiesconditionally registered only when gate is closed), 25 MB attachment cap, file/symlink rejection, date filter descriptions, and pinned-note filter all match implementation.^24.13.0requirement consistent acrosspackage.json,manifest.json, README, and NPM.md; Claude Code and generic MCP install commands verified accurate.infra → operations → toolsdependency 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.Generated by Claude Code