docs-update
Skill25 starsChanged 24 days agoMITView on GitHub
Update the Spotnote docs site (docs/) after a change users can see. Finds the pages a code change touches, fixes links to renamed headings, retakes screenshots, rebuilds the demo videos, and checks the docs build. Use after changing the UI, the prompt, the plugin options or the MCP tools, or when the user asks to update the docs.
17 other projects use a version of this, 1 of them edited.
Adopted by
Most recently taken up by
- microsoft/veronaedited, first seen Nov 8, 2026
- buildomator/buildomatortheir own version, first seen Nov 4, 2026
- aka-kika/akakika-skillstheir own version, first seen Nov 1, 2026
- davidanthonyn/claude-skillstheir own version, first seen Oct 20, 2026
- jellydn/my-ai-toolstheir own version, first seen Oct 18, 2026
- Atiqul-Islam/graphcrewtheir own version, first seen Oct 13, 2026
Other versions17 projects use a version of this.
Word for word · 0
None found.
Edited · 1
- microsoft/verona★ 3.7k10% same
Wrote their own version · 16
- warpdotdev/oz-skills★ 825same name
- bagofwords1/bagofwords★ 463same name
- hiromaily/go-crypto-wallet★ 128same name
- jellydn/my-ai-tools★ 127same name
- TangleML/tangle-ui★ 104same name
- buildomator/buildomator★ 102same name
- aka-kika/akakika-skills★ 11same name
- Escoto/RustifyMyClaw★ 8same name
- mgiovani/cc-arsenal★ 8same name
- kaisdavis/claude-skills★ 1same name
6 more not listed
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 repository7 other files it gives its agents.
- AGENTS.mdAGENTS.md
- .claude/CLAUDE.mdCLAUDE.md
- examples-new-frameworkSkill
- examples-reproSkill
- examples-syncSkill
- releaseSkill
- spotnote-setupSkill
The file
We split this skill into the rules it gives an agent
8 rules. 0 are common, 1 is distinctive, and 7 are very specific to this project.
0
Common
Most of the 16 edited versions we read keep these.
1
Distinctive
This author's own choices. Worth a look.
7
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 14
Start from what changed (git diff, or the commits since the docs last changed):
- Very specific: line 61
Start the React example: pnpm dev (http://localhost:5173).
- Very specific: line 66
Look at the result. Set the <img>'s width to the one the script prints, and update its alt if what it shows changed.
- Very specific: line 81
If the capture warns a value wasn't replaced, the client's markup moved under a placeholder: fix the patterns at the end of …
- Very specific: line 84
Look at the frames that show the change: npx remotion still src/index.jsx Solo out/f.png --frame=<n> (in demo/.
- Very specific: line 89
If the prompt's wording changed, update demo/src/script.js to match: the videos type and paste it as written there.
- Very specific: line 96
Every render changes the files' bytes, even when nothing shows a change: if the videos don't show the change, git checkout …
- Very specific: line 112
Commit the docs with the code change they describe, or as docs: … on their own.
“Common” is measured: kept by at least 6 in 10 of the 16 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
Update the docs
The docs are a Fumadocs site: pages in docs/content/docs/*.mdx, images in
docs/public/. Search is built from the pages at build time: there's nothing to
update for it.
1. Find the pages
Start from what changed (git diff, or the commits since the docs last changed):
| Code | Page (under docs/content/docs/) |
client/inspector.ts: picking, Esc, Alt | guides/picking-elements.mdx |
client/panel.ts, client/pins.ts: the note panel, pins, several elements | guides/notes.mdx |
client/notes-list.ts | guides/notes.mdx (Delete notes, The notes list) |
client/settings-menu.ts, client/settings.ts | guides/settings.mdx |
client/prompt.ts | reference/prompt-format.mdx |
client/open-file.ts | guides/settings.mdx (Open files in) |
client/webhook.ts, the webhook option | guides/webhook.mdx, reference/plugin-api.mdx |
client/launcher.ts | getting-started/quick-start.mdx, guides/picking-elements.mdx |
src/index.ts options, warnings | reference/plugin-api.mdx |
src/stamp/*.ts, stamping per framework | reference/framework-support.mdx, concepts.mdx |
mcp/src/tools.ts | guides/mcp.mdx (MCP Tools) |
mcp/src/store.ts, localStorage keys | reference/storage.mdx |
| Something it can't do | limitations.mdx, faq.mdx |
Also search for the old wording, since a name can be on more pages than the table
shows: grep -rn "Old name" docs/content README.md package/README.md mcp/README.md.
2. Write the change
- Match the page: short sentences, the UI's own words in bold, keys in
backticks (
Shift+click), steps as a numbered list. - UI buttons drawn inline:
<PanelButton icon="trash" />,<LauncherItem icon="notes" />,<SendButton label="Add" />,<PinIcon n={1} />(seedocs/components/). - A new page goes in its folder's
meta.json(pages, in order), withtitleanddescriptionin its frontmatter. The description shows in the page header and in search results.
3. Fix links to renamed headings
A heading's anchor is its text, lowercased, spaces as -: ## Coding agent is
#coding-agent. When you rename or remove a heading:
grep -rn "#old-anchor" docs/content README.md package/README.md mcp/README.mdFix each link, and its text if it names the heading (Settings → MCP).
4. Retake screenshots that show the change
Find them: grep -n 'src="/' docs/content/docs/<page>.mdx, then look at each
image the change is visible in. Retake those; leave the rest.
- Start the React example:
pnpm dev(http://localhost:5173). - Copy
screenshot.mjs(next to this file) intoe2e/, and change itsstage()to set up what the image shows. Keep what the old image showed (the same notes, the same page) so only the change differs. (cd e2e && node _shot.mjs ../docs/public/<name>.png) && rm e2e/_shot.mjs- Look at the result. Set the
<img>'swidthto the one the script prints, and update itsaltif what it shows changed.
5. Rebuild the demo videos
Five videos are made from code, in demo/ (Remotion), with Spotnote's UI taken
from the real client: solo-demo.mp4 (the home page), staging-demo.mp4
(Staging Builds), webhook-demo.mp4 (Webhook) and the Quick Start's
quick-start-click.mp4 and quick-start-note.mp4. Rebuild them when a change shows in them: the launcher, the
hover outline and label, the note panel, pins, or the prompt's wording.
pnpm --filter spotnote-demo run refresh(about 3 minutes). It runs the React example on port 5300, captures the UI intodemo/src/spotnote/snapshots.js, renders the videos and copies them intodocs/public/. (Notpnpm update: that's pnpm's own command, and it updates dependencies.)- If the capture warns
a value wasn't replaced, the client's markup moved under a placeholder: fix the patterns at the end ofdemo/scripts/capture.js, and run it again. - Look at the frames that show the change:
npx remotion still src/index.jsx Solo out/f.png --frame=<n>(indemo/;Demofor the staging video,Webhook, andQuickClickandQuickNotefor the Quick Start's). The timings are at the top of each one's file insrc/. - If the prompt's wording changed, update
demo/src/script.jsto match: the videos type and paste it as written there. - The README shows the staging and webhook videos too, as uploads on GitHub:
tell the user to drop the new
demo/out/demo.mp4(Staging builds) ordemo/out/demo-webhook.mp4(Webhook) into the README in GitHub's editor, in place of the old one.
Every render changes the files' bytes, even when nothing shows a change: if
the videos don't show the change, git checkout docs/public/*-demo.mp4.
The MCP page's video (demo.mp4, also in the README) is recorded by hand: if
it shows the change, tell the user rather than retaking it.
6. Check
pnpm --filter @spotnote/docs buildIt must pass (CI builds it too). Then open the changed pages on
pnpm --filter @spotnote/docs dev (http://localhost:3000) if anything about their
layout changed.
Commit the docs with the code change they describe, or as docs: … on their own.
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.

