uplift.page
← library
skill📝 Docs & writingv1 · updated 2026-10-09

Auto Doc Update

Pulls the current documentation for any library, API, app, or vendor into the repo as short dated notes agents read before working, and keeps them fresh with a weekly check that flags which sources changed, starting from the changelog. Use when setting up AI context for a tool or vendor, when the model's knowledge of a fast-moving product may be stale, when asked to refresh, sync, or check docs, or before relying on a vendor's API, CLI, or limits.

Run it as a prompt

Paste this into any AI agent, or fetch it: curl -s https://uplift.page/api/v1/prompts/auto-doc-update/raw

prompt.md
# Auto Doc Update

Fast-moving products change monthly; the model's training lags. Keep the vendor's own
docs in the repo as dated notes and re-check them weekly, so agents work from what is
true now. Docs are evidence: when the installed binary or the live app disagrees, the
running thing wins and the disagreement goes in the notes.

## When to use

- "Grab the docs for X", "give the agent context on X", "keep these docs up to date"
- Weekly, or before relying on a vendor's API, CLI, limits, or pricing

## Steps

1. **Set up once.** Run `node scripts/check-docs.mjs --init` (or download it from
   `https://uplift.page/tools/check-docs.mjs`) to create `docs/context/`. In `sources.json`
   list official sources only: the changelog or release notes first, then the doc pages,
   API reference, `llms.txt`, GitHub README/releases, and `--help` of any CLI. Run with
   `--suggest`: many doc sites serve clean markdown at `<page>.md`.
2. **Check.** `node scripts/check-docs.mjs --capture` (`--run-cmd` for CLI sources). Open each
   new capture once to confirm it holds the real content, not a sign-in or JS shell.
3. **Reconcile.** Read the changelog first. For each CHANGED or NEW source, diff the captures,
   update the listed notes claim by claim, and set `verified:` to today. Re-check any
   open items in `findings.md`; move fixed ones to "Fixed since <date>".
4. **Accept, then log.** Only after the notes match: `--accept <ids>`. Add a `log.md` entry:
   checked, changed (with release dates), notes updated, errors.
5. **Point agents at it.** Add one line to the repo's agent instructions file: "Before
   using <vendor>, read `docs/context/notes/`; if `verified` is over 14 days old, run the
   doc check." Offer a weekly scheduled run that opens a PR and never merges.

## Rules

- Never `--accept` before the notes are updated; the checker would then report all clear on stale notes.
- An ERROR means a partial run. Say which sources failed; never call it all clear.
- Official sources only. Label anything third-party and date every claim.
- Captures in `raw/` are never edited; a change gets a new dated file.
- Sources behind a sign-in are `manual` with written re-harvest steps. Never store credentials.

Install it as a skill

Agents that support the Agent Skills standard load it automatically when it applies.

download
curl -fsSL https://uplift.page/p/auto-doc-update/SKILL.md --create-dirs -o .agents/skills/auto-doc-update/SKILL.md
or from any MCP client
MCP server: https://uplift.page/mcp
Tool: pull_skill  {"slug": "auto-doc-update"}

The full skill

Fast-moving products change monthly; the model's training lags. Keep the vendor's own docs in the repo as dated notes and re-check them weekly, so agents work from what is true now. Docs are evidence: when the installed binary or the live app disagrees, the running thing wins and the disagreement goes in the notes.

When to use

  • "Grab the docs for X", "give the agent context on X", "keep these docs up to date"
  • Weekly, or before relying on a vendor's API, CLI, limits, or pricing

Steps

  1. Set up once. Run node scripts/check-docs.mjs --init (or download it from https://uplift.page/tools/check-docs.mjs) to create docs/context/. In sources.json list official sources only: the changelog or release notes first, then the doc pages, API reference, llms.txt, GitHub README/releases, and --help of any CLI. Run with --suggest: many doc sites serve clean markdown at <page>.md.
  2. Check. node scripts/check-docs.mjs --capture (--run-cmd for CLI sources). Open each new capture once to confirm it holds the real content, not a sign-in or JS shell.
  3. Reconcile. Read the changelog first. For each CHANGED or NEW source, diff the captures, update the listed notes claim by claim, and set verified: to today. Re-check any open items in findings.md; move fixed ones to "Fixed since ".
  4. Accept, then log. Only after the notes match: --accept <ids>. Add a log.md entry: checked, changed (with release dates), notes updated, errors.
  5. Point agents at it. Add one line to the repo's agent instructions file: "Before using , read docs/context/notes/; if verified is over 14 days old, run the doc check." Offer a weekly scheduled run that opens a PR and never merges.

Rules

  • Never --accept before the notes are updated; the checker would then report all clear on stale notes.
  • An ERROR means a partial run. Say which sources failed; never call it all clear.
  • Official sources only. Label anything third-party and date every claim.
  • Captures in raw/ are never edited; a change gets a new dated file.
  • Sources behind a sign-in are manual with written re-harvest steps. Never store credentials.

Layout

docs/context/
  sources.json   what to watch (edit this)
  baseline.json  fingerprints accepted after the last reconcile (written by the script)
  notes/         what agents read: one topic per file, under ~500 words
  raw/           dated captures, never edited
  log.md         one entry per run, newest first
  findings.md    optional: open claims or recommendations re-checked every run

Source modes

mode for changed when
text an HTML doc page the page's main text changes (digits kept, so limits and versions count)
raw .md pages, llms.txt, JSON APIs (e.g. a GitHub commits URL) any byte changes
head a build, download, or file you won't fetch its ETag or Last-Modified moves
cmd tool --help, npm view pkg version the output changes (needs --run-cmd)
manual anything behind a sign-in every_days pass since the last accept 
{ "id": "cli-reference", "url": "https://example.com/docs/cli.md", "mode": "raw",
  "notes": ["notes/cli.md"], "why": "commands and flags" }

Exit codes: 0 nothing changed, 1 something to reconcile, 3 a source failed. Set GITHUB_TOKEN to avoid GitHub API rate limits. A thin warning means the page renders in the browser; switch to its .md version or llms.txt.

Note format

---
sources: [cli-reference, changelog]
verified: 2026-10-09   # last checked against the source, not last edited
status: ga             # ga | beta | deprecated | source-missing
---
# CLI commands
- `tool deploy --dry-run` previews changes (cli-reference)

Keep notes to what an agent needs to act: commands, limits, auth, gotchas, what changed. When a source 404s, keep the note, set status: source-missing, and find the new URL.

Scheduling

Run weekly from a clean checkout of the default branch, on a fresh branch. Open a PR titled "Doc refresh " with the log entry as its body, and stay silent when nothing changed. Never merge or deploy from the scheduled run.

Served from the uplift.page library and refreshed within 5 minutes of every update.