skills.rest
JSdotNet
JSdotNetCOMMUNITY
Explore all skills by this author →
GitHub

annotation-sweep

Deletes resolved annotation fences from devbook chapters before branch merges.

Updated Sep 2, 2026
Search Tags:#code review#documentation#markdown#pull request#cleanup#annotations#devbook
One-click install
npx skills add https://github.com/JSdotNet/devbook --skill annotation-sweep-jsdotnet
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: annotation-sweep
Source: https://github.com/JSdotNet/devbook/tree/main/plugins/devbook/skills/annotation-sweep
Command: npx skills add https://github.com/JSdotNet/devbook --skill annotation-sweep-jsdotnet

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Resolved review annotations linger in devbook chapters and pollute pull request diffs, even though the prose change is the permanent record. This Skill removes every resolved annotation fence from a chapter so branches merge clean without carrying answered notes. ## Core Features & Use Cases - Scoped Sweeping: Deletes only status: resolved annotation fences in a single chapter address (<path>#<slug>), never touching open notes. - Preview Before Deletion: Lists each note's author, date, kind, body, and answering reply before any deletion occurs. - Tool-Enforced Writes: Uses annotations.mjs sweep as the only writer, preventing manual fence edits that could corrupt chapter metadata. - Use Case: Before opening a pull request, sweep a reviewed chapter so answered reviewer comments disappear from the diff while open questions remain visible. ## Quick Start Sweep the resolved annotations from the chapter at .devbook/arc42/adr/plugin-boundaries.md before I merge this branch.

Frequently Asked Questions about annotation-sweep

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I remove resolved annotations from a devbook chapter?▼

Run the annotations.mjs sweep command with a chapter address in path#slug format. It deletes every fence with status resolved and leaves open notes untouched. Always list the resolved notes first so a person can review what will go.

What is the annotation lifecycle in a devbook chapter?▼

Annotations move through three states: open means someone is waiting for an answer, resolved means answered and lives only for the rest of the branch, and gone is the resting state after a sweep. The prose change is the permanent record; git holds the rest.

Can I sweep annotations across an entire folder at once?▼

No, sweeping is chapter-scoped by design. A path with no slug sweeps every chapter in that one file, but folders are never swept because a person must be able to look at what is about to be deleted.

Why does the sweep tool refuse to delete open annotations?▼

An open note means somebody is still waiting for an answer, so deleting it would silently drop an unanswered question. Only fences with status resolved are removed, and resolving a note requires a separate reply plus resolve step by whoever answered it.

What happens if the devbook-meta tools directory is missing?▼

When .devbook/_tools/devbook-meta/ is absent, run devbook:update to restore the tooling, or devbook:init where devbook has no stamp yet. The sweep cannot proceed without annotations.mjs, which is the only permitted writer.

Related Skills

Explore More Software Engineering Skills→
kieranpottskieranpotts

resolve

Implements, verifies, and resolves open review comments on a pull request.

Community
Advanced
HallmanacHallmanac

pr-summary

Generate pull-request titles and descriptions from branch commits for reviewer-oriented prose.

Community
Intermediate
tradingstrategy-aitradingstrategy-ai
823

add-vault-note

Add human-readable notes to a vault notes store and open a pull request.

Official
Advanced
PostHogPostHog
713

writing-code-comments

Reviews and rewrites code comments to explain why rather than restate what the code does.

Official
Basic