review-doc
Skill20 starsChanged 16 days agoMITView on GitHub
Render any document the user needs to review (design docs, plans, story bibles, proposals, reports) as a self-contained HTML page with Google-Docs-style commenting — highlight text, attach notes, export feedback. Use whenever producing or updating a document whose primary purpose is for the user to READ AND REACT TO, whenever the user asks for "a review doc", or when they hand back a *.feedback.md file. The user has standing instructions that all review documents get this treatment.
7 other projects use a version of this.
Adopted by
Most recently taken up by
- koruworks/skillstheir own version, first seen Oct 15, 2026
- Endava/BEEQtheir own version, first seen Oct 8, 2026
- kohj1018/agentic-dev-harnesstheir own version, first seen Sep 29, 2026
- mekenthompson/ProductOStheir own version, first seen Jul 23, 2026
- tomharris/engineer-agenttheir own version, first seen Jul 22, 2026
- DGouron/review-flowtheir own version, first seen May 14, 2026
Other versions7 projects use a version of this.
Word for word · 0
None found.
Edited · 0
None found.
Wrote their own version · 7
- Endava/BEEQ★ 162same name
- DGouron/review-flow★ 42same name
- kohj1018/agentic-dev-harness★ 2same name
- mekenthompson/ProductOS★ 1same name
- junhjang/claude-harness★ 0same name
- koruworks/skills★ 0same name
- tomharris/engineer-agent★ 0same name
How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.
In this repository12 other files it gives its agents.
- CLAUDE.mdCLAUDE.md
- grill-meSkill
- paper-reviewSkill
- plain-speechSkill
- see-uiSkill
- tufte-vizSkill
- grill-meSkill
- paper-reviewSkill
- plain-speechSkill
- review-docSkill
- see-uiSkill
- tufte-vizSkill
The file
We split this skill into the rules it gives an agent
3 rules. 0 are common, 2 are distinctive, and 1 is very specific to this project.
0
Common
Most of the 6 edited versions we read keep these.
2
Distinctive
This author's own choices. Worth a look.
1
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- could be automatic: a setting could enforce it
- Distinctive: line 22
The markdown source stays canonical: Never hand-edit the generated HTML.
- Very specific: line 32
When the user returns a *.feedback.md (or pastes its contents): read every quoted passage + note, respond to or apply each one, then …
- Distinctive: line 45
If the user asks for review docs in some other format, that wins.
“Common” is measured: kept by at least 6 in 10 of the 6 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
review-doc — reviewable HTML documents with margin comments
What this produces
A single self-contained .review.html file (no network, no deps) that
renders a markdown document with:
- Google-Docs-style commenting: select text → 💬 → type a note; comments live as cards in a right margin rail, anchored to highlights.
- Persistence in
localStorage(survives reload, keyed per document). - Export feedback button → downloads
<doc>.feedback.md(quoted passages + the user's notes) and a copy-to-clipboard alternative. - General (unanchored) comments, dark/light theme support.
Workflow
- The markdown source stays canonical. Never hand-edit the generated HTML; regenerate it.
- Generate:
node <dir-containing-this-SKILL.md>/build-review.mjs <source.md> [out.html](the script sits next to this SKILL.md — use the path you read it from) (default output:<source>.review.htmlnext to the source). - Deliver:
open <out.html>on macOS so it lands in the user's real browser (commenting + export need a full browser, not a preview pane), and/or send the file. Tell the user the loop in one line: highlight → comment → Export feedback → give me the file. - When the user returns a
*.feedback.md(or pastes its contents): read every quoted passage + note, respond to or apply each one, then regenerate the review HTML from the updated markdown. Existing comments re-anchor by quote; notes on text that changed appear in the rail as "unanchored" rather than being lost.
Notes
- Works for any markdown: headings, tables, lists, code fences, blockquotes, links, images.
- The document id (localStorage key + feedback filename) is derived from the output filename — keep it stable across regenerations so the user's in-progress comments survive.
- If the user asks for review docs in some other format, that wins.
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.