New: 97,000+ skills indexed from GitHub repos with 100+ stars · every skill safety-checkedBrowse top skillsTop skills
Esc to closeBrowse all skills
Submit a skillBrowse skills
Submit a skillBrowse skills

Official agent skill

Docs Sync

by redis in redis/node-redis

Analyze master branch implementation and configuration to find missing, incorrect, or outdated documentation in docs/, README.md, and per-package READMEs.

OfficialMITAuto-check passedDevelopment

Install Docs Sync

skills CLI
$ npx skills add redis/node-redis --skill docs-sync -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install redis/node-redis docs-sync --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/redis/node-redis.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.agents/skills/docs-sync .claude/skills/docs-sync && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
docs-sync
GitHub stars
18k
Token cost
~1.1k tokens
SKILL.md length
484 words
Files
3 (incl. references)
Skills in repo
7
Repo updated
First seen
Licence
MIT

At a glance

Analyze master branch implementation and configuration to find missing, incorrect, or outdated documentation in docs/, README.md, and per-package READMEs.

  • Works in 7 steps: Confirm scope and base branch → Build a feature inventory from the… → Doc-first pass: review existing pages → …
  • Asked to audit doc coverage
  • SKILL.md covers Overview, Workflow, Output format and References
  • Calls rg, git and npm

What it does

Docs Sync is an agent skill from redis/node-redis, published by the product's own GitHub organization. Analyze master branch implementation and configuration to find missing, incorrect, or outdated documentation in docs/, README.md, and per-package READMEs. Use when asked to audit doc coverage, sync docs with code, or propose doc updates/structure changes. Provide a report and ask for approval before editing docs.

Its SKILL.md is about 1.1k tokens, which your agent loads only when the skill is triggered. The skill folder holds 4 other files, including reference files (for example `agents/openai.yaml` and `references/doc-coverage-checklist.md`).

It sits in Development, covering Technical documentation. It works with Redis. The licence is MIT.

When your agent uses it

  • Asked to audit doc coverage
  • Sync docs with code
  • Propose doc updates/structure changes

Example prompts

  • “/docs-sync”

Workflow steps

7 steps, taken from the first numbered list in SKILL.md.

  1. Confirm scope and base branch
  2. Build a feature inventory from the selected scope
  3. Doc-first pass: review existing pages
  4. Code-first pass: map features to docs
  5. Detect gaps and inaccuracies
  6. Produce a Docs Sync Report and ask for approval
  7. If approved, apply changes

What it can do on your machine

Read from SKILL.md and the folder at commit 98747a7. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    Shell commands in SKILL.md call:

    • rg
    • git
    • npm

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    Links to these hosts (documentation or services it may open):

    • redis.io

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Docs Sync loads about 1.1k tokens when it runs, and up to ~1.7k if it reads all its reference files. Until then it costs about 81 tokens; SKILL.md has 484 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~81
When it runs · the whole SKILL.md, loaded when a task matches
~1.1k
With references · SKILL.md plus every file in references/, read only if the agent opens them
~1.7k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from redis/node-redis at commit 98747a7, republished under its MIT licence (© redis). 484 words, ~1,062 tokens.

Download SKILL.mdSave it as .claude/skills/docs-sync/SKILL.md (or your agent's skills folder). This skill also uses 2 other files; get the full folder from GitHub.
name
docs-sync
description
Analyze master branch implementation and configuration to find missing, incorrect, or outdated documentation in docs/, README.md, and per-package READMEs. Use when asked to audit doc coverage, sync docs with code, or propose doc updates/structure changes. Provide a report and ask for approval before editing docs.

Docs Sync

Overview

Identify doc coverage gaps and inaccuracies by comparing master branch features and configuration options against the current docs, then propose targeted improvements.

Workflow

  1. Confirm scope and base branch

    • Identify the current branch and default branch (master).
    • Prefer analyzing the current branch to keep work aligned with in-flight changes.
    • If the current branch is not master, analyze only the diff vs master to scope doc updates.
    • Avoid switching branches if it would disrupt local changes; use git show master:<path> or git worktree add when needed.

  2. Build a feature inventory from the selected scope

    • If on master: inventory the full surface area and review docs comprehensively.
    • If not on master: inventory only changes vs master (feature additions/changes/removals).
    • Focus on user-facing behavior: public exports, client/cluster/sentinel/pool config options, new or changed commands, connection-string options, default values, and documented runtime behaviors.
    • Capture evidence for each item (file path + symbol/setting).
    • Use targeted search to find option types and feature flags (for example: rg "Options", rg "interface .*Options", rg "export" under packages/*/lib).
    • For Redis command behavior or server-side semantics, treat the source code (parseCommand/transformReply in packages/*/lib/commands) as the source of truth; consult redis.io/commands only to confirm server semantics when discrepancies appear.

  3. Doc-first pass: review existing pages

    • Walk each relevant page under docs/, the top-level README.md, and each packages/*/README.md.
    • Identify missing mentions of important, supported options (opt-in flags, config), customization points, or new features from packages/.
    • Propose additions where users would reasonably expect to find them on that page.

  4. Code-first pass: map features to docs

    • Review the current docs layout under docs/ (e.g. client-configuration.md, clustering.md, sentinel.md, pool.md, RESP.md, transactions.md, programmability.md, pub-sub.md, scan-iterators.md, command-options.md).
    • Determine the best page/section for each feature based on existing patterns and package boundaries.
    • Identify features that lack any doc page or have a page but no corresponding content.
    • Note when a structural adjustment would improve discoverability.

  5. Detect gaps and inaccuracies

    • Missing: features/configs present in master but absent in docs.
    • Incorrect/outdated: names, defaults, or behaviors that diverge from master.
    • Structural issues (optional): pages overloaded, missing overviews, or mis-grouped topics.

  6. Produce a Docs Sync Report and ask for approval

    • Provide a clear report with evidence, suggested doc locations, and proposed edits.
    • Ask the user whether to proceed with doc updates.

  7. If approved, apply changes

    • Edit docs under docs/, README.md, and the relevant packages/*/README.md.
    • Keep changes aligned with the existing docs style and navigation.
    • Place any runnable code snippets under examples/ or doctests/, mirroring existing patterns.
    • Verify any snippet you add still compiles with npm run build and fix issues before handoff.
Show full SKILL.md (59 more words)Show less

Output format

Use this template when reporting findings:

Docs Sync Report

  • Doc-first findings
    • Page + missing content → evidence + suggested insertion point
  • Code-first gaps
    • Feature + evidence → suggested doc page/section (or missing page)
  • Incorrect or outdated docs
    • Doc file + issue + correct info + evidence
  • Structural suggestions (optional)
    • Proposed change + rationale
  • Proposed edits
    • Doc file → concise change summary
  • Questions for the user

References

  • references/doc-coverage-checklist.md

© redis, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

SKILL.md and 2 other files (references) in .agents/skills/docs-sync of redis/node-redis.

  • SKILL.md
  • agents/openai.yaml
  • references/doc-coverage-checklist.md

Open the folder on GitHubat commit 98747a7

Compare with similar skills

Docs Sync next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Docs Sync compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Docs Sync this skillredis/node-redis18k—~1.1kAutomated safety check: PassMIT
Audit Docschrisguidry/docket148—~2.1kAutomated safety check: PassCustom licence
Repo Guardsimovilab/databus101—~1.3kAutomated safety check: PassApache-2.0
Add Redis Command to go-redisredis/go-redis22k—~1.4kAutomated safety check: PassBSD-2-Clause
Add Garnet RESP Commandmicrosoft/garnet12k—~9.7kAutomated safety check: PassMIT
FoundatioFoundatioFx/Foundatio2.1k—~3.9kAutomated safety check: PassApache-2.0

Similar skills

  • Audit Docs

    chrisguidry/docket

    As you edit pydocket — change a function body, modify a signature, alter a Lua script, refactor a public method, rewrite a docs section — verify that the docstrings and narrative docs touching that…

    148 GitHub stars~2.1k tokensUpdated today
    DevelopmentAuto-check passed

  • Repo Guard

    simovilab/databus

    Keep the databus repo clean as it grows — verify new/changed backend code meets the project's docstring, type-hint, and structural conventions, and update any docs the change made stale.

    101 GitHub stars~1.3k tokensUpdated 29 days ago
    DevelopmentAuto-check passed

  • Add Redis Command to go-redis

    redis/go-redis

    Official

    Walks through adding a new Redis or Redis module command to the go-redis client, from fetching the spec and docs to the type, interface wiring, parsing and tests.

    22k GitHub stars~1.4k tokensUpdated yesterday
    DevelopmentAuto-check passed

  • Add Garnet RESP Command

    microsoft/garnet

    Official

    Step-by-step guide for adding a new built-in RESP command to Garnet, from the command enum and parser to storage callbacks, command metadata JSON and tests.

    12k GitHub stars~9.7k tokensUpdated today
    DevelopmentAuto-check passed

  • Foundatio

    FoundatioFx/Foundatio

    A skill your agent uses when working with Foundatio infrastructure abstractions for .NET -- caching, queuing, messaging, file storage, distributed locking, or background jobs.

    2.1k GitHub stars~3.9k tokensUpdated today
    Backend & APIsAuto-check passed

  • Record Prisma 8 Upgrade Instructions

    prisma/orm

    Official

    Adds an upgrade-instruction fragment to a Prisma 8 breaking-change PR so downstream app and extension authors can apply the matching code translation.

    48k GitHub stars~3.2k tokensUpdated yesterday
    DevelopmentAuto-check: notes

More from redis/node-redis

  • Runtime Behavior Probe

    redis/node-redis

    Official

    Plan and execute runtime-behavior investigations with temporary TypeScript probe scripts, validation matrices, state controls, and findings-first reports.

    18k GitHub stars~4.4k tokensUpdated yesterday
    Auto-check passed

  • Implement Command

    redis/node-redis

    Official

    Add a new Redis command (or command variant) to node-redis end-to-end — the <NAME.ts Command file, its registration with JSDoc in the package commands/index.ts, and a co-located <NAME.spec.ts with…

    18k GitHub stars~5k tokensUpdated yesterday
    Auto-check passed

  • Maintainer Triage

    redis/node-redis

    Official

    Batch-triage and act on a set of node-redis PRs (or issues) by filter — fan out the maintainer-review methodology across them, present a one-word verdict plus a tldr to the user one at a time for…

    18k GitHub stars~1.9k tokensUpdated yesterday
    Auto-check passed

  • Bump Test Image

    redis/node-redis

    Official

    Bump the default Redis docker test image (redislabs/client-libs-test) in the shared DEFAULTDOCKERCONFIG and the CI matrix, then force-push the bump-test-image branch and open a PR against upstream.

    18k GitHub stars~1.4k tokensUpdated yesterday
    Auto-check passed

  • Maintainer Review

    redis/node-redis

    Official

    Review a GitHub issue or pull request URL as a node-redis maintainer, with a staged assessment of whether the claim is real, practically important, already solvable with supported functionality…

    18k GitHub stars~5.5k tokensUpdated yesterday
    Auto-check passed

  • PR Draft Summary

    redis/node-redis

    Official

    Create the required PR-ready summary block, branch suggestion, title, and draft description for node-redis.

    18k GitHub stars~1.4k tokensUpdated yesterday
    Auto-check: warnings

Works with

Categories

Questions about Docs Sync

What does Docs Sync do?

Analyze master branch implementation and configuration to find missing, incorrect, or outdated documentation in docs/, README.md, and per-package READMEs. Docs Sync is an agent skill from redis/node-redis, published by the product's own GitHub organization.md, and per-package READMEs.

When should I use Docs Sync?

Docs Sync fits situations like: asked to audit doc coverage; sync docs with code; propose doc updates/structure changes.

How do I install Docs Sync in Claude Code?

Run `npx skills add redis/node-redis --skill docs-sync -a claude-code`. Or copy the skill folder (.agents/skills/docs-sync in redis/node-redis) into .claude/skills/docs-sync in your project. Claude Code loads it when a task matches its description.

How do I install Docs Sync in Codex?

Run `npx skills add redis/node-redis --skill docs-sync -a codex`. Or copy the skill folder (.agents/skills/docs-sync in redis/node-redis) into .agents/skills/docs-sync in your project. Codex loads it when a task matches its description.

Can I use Docs Sync in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add redis/node-redis --skill docs-sync -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/docs-sync, .gemini/skills/docs-sync, .github/skills/docs-sync and .opencode/skills/docs-sync in your project.

What does Docs Sync need to run?

Going by SKILL.md and its folder, Docs Sync needs the command-line tools its instructions call (rg, git and npm).

Does Docs Sync access the network?

SKILL.md names 1 domain. As links in the text: redis.io. This is read from the text; nothing was executed.

Is Docs Sync safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Docs Sync use?

Docs Sync is published under the MIT licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Docs Sync use?

About 1.1k tokens (SKILL.md is roughly 4.2k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full. Its references folder adds about 678 tokens, read only when the agent opens those files.

What are the alternatives to Docs Sync?

Skills that share tags, products or a category with Docs Sync: Audit Docs (chrisguidry/docket, 148 stars), Repo Guard (simovilab/databus, 101 stars), Add Redis Command to go-redis (redis/go-redis, 22k stars) and Add Garnet RESP Command (microsoft/garnet, 12k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Docs Sync?

redis (a GitHub organization, an official publisher) maintains it in redis/node-redis, which has 17,585 GitHub stars. The repository holds 7 skills in this directory. The repository was last updated on October 6, 2026.

Source: redis/node-redis on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.