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

Agent skill

Documentation Sync Check

by ZeroDeng01 in ZeroDeng01/sublinkPro

Checklist for keeping README, feature, configuration, install and API docs in step with code changes in the same PR, including the Chinese copies.

MITAuto-check passedDevelopment

Install Documentation Sync Check

skills CLI
$ npx skills add ZeroDeng01/sublinkPro --skill doc-sync-check -a claude-code

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

GitHub CLI
$ gh skill install ZeroDeng01/sublinkPro doc-sync-check --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/ZeroDeng01/sublinkPro.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.agents/skills/doc-sync-check .claude/skills/doc-sync-check && 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
doc-sync-check
GitHub stars
1.7k
Token cost
~2.6k tokens
SKILL.md length
992 words
Files
1
Skills in repo
8
Repo updated
First seen
Licence
MIT

At a glance

Checklist for keeping README, feature, configuration, install and API docs in step with code changes in the same PR, including the Chinese copies.

  • Works in 3 steps: Identify which documentation files might… → Read AGENTS.md section "Documentation… → Review CONTRIBUTING.md for documentation…
  • Finishing a change that adds or alters a configuration option or environment variable
  • SKILL.md covers When to use this skill, Core Principle, Prerequisites and Quick Reference: Which Docs to…, plus 11 more sections
  • Calls yarn

What it does

Another workflow, post-dev-workflow, invokes this checklist when code changes affect documentation, and it is not meant to be called directly. The rule is that docs change in the same PR as the code. It applies to user-visible behavior, API contracts, configuration options and environment variables, installation or deployment steps, developer workflows and build or validation processes.

Before starting, the agent identifies which docs may be affected and reads the documentation expectations in AGENTS.md and CONTRIBUTING.md. A lookup table maps each change type to files such as README.md, docs/features, docs/configuration.md, docs/installation.md, docs/development.md and the skill-sublinkpro reference pages, each paired with a .zh-CN.md version. Tick-box lists cover README updates, feature docs, cross-references and the configuration guide. The layout is specific to the sublinkPro repository.

When your agent uses it

  • Finishing a change that adds or alters a configuration option or environment variable
  • Updating docs after an API endpoint changes
  • Checking that README and feature docs match a new user-facing feature in both languages

Example prompts

  • “I added a new env variable; list which docs and zh-CN copies need updating.”
  • “Run the doc sync checklist for this API endpoint change.”
  • “Check that README.md and README.zh-CN.md both reflect the new feature.”

Requirements

  • The sublinkPro repository, including its AGENTS.md, CONTRIBUTING.md and docs folder

Workflow steps

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

  1. Identify which documentation files might be affected
  2. Read AGENTS.md section "Documentation expectations"
  3. Review CONTRIBUTING.md for documentation standards

What it can do on your machine

Read from SKILL.md and the folder at commit 11479da. 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:

    • yarn

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

  • Network

    No URLs in SKILL.md. Its commands use yarn, which can reach the network depending on how they are called.

    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

Documentation Sync Check loads about 2.6k tokens when it runs. Until then it costs about 48 tokens; SKILL.md has 992 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~48
When it runs · the whole SKILL.md, loaded when a task matches
~2.6k

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 ZeroDeng01/sublinkPro at commit 11479da, republished under its MIT licence (© ZeroDeng01). 992 words, ~2,599 tokens.

Download SKILL.mdSave it as .claude/skills/doc-sync-check/SKILL.md (or your agent's skills folder).
name
doc-sync-check
description
Documentation synchronization checklist for API, configuration, and feature changes. Invoked by post-dev-workflow when code affects documentation. Not for direct user invocation.
version
1.0.0
author
SublinkPro Team
user-invocable
false

Documentation Sync Check Skill

Checklist for ensuring documentation stays synchronized with code changes.

When to use this skill

Use this skill when changes affect:

  • User-visible behavior or features
  • API contracts or endpoints
  • Configuration options or environment variables
  • Deployment or installation procedures
  • Developer workflows or contribution processes
  • Build or validation processes

Core Principle

Documentation must be updated in the same PR as the code change. Outdated docs are a maintenance burden and user pain point.

Prerequisites

Before running this checklist:

  1. Identify which documentation files might be affected
  2. Read AGENTS.md section "Documentation expectations"
  3. Review CONTRIBUTING.md for documentation standards

Quick Reference: Which Docs to Update

Change TypeDocs to Check
User-facing featureREADME.md + .zh-CN.md, docs/features/*.md + .zh-CN.md
Configuration optiondocs/configuration.md + .zh-CN.md, example configs
Installation/deploymentdocs/installation.md + .zh-CN.md, skill-sublinkpro/reference/deploy.md
API endpointskill-sublinkpro/reference/api.md
Developer workflowdocs/development.md + .zh-CN.md, CONTRIBUTING.md + .zh-CN.md
Architecture/guidelinesAGENTS.md
New documentationskill-sublinkpro/reference/docs.md (documentation map)

Feature Documentation Checklist

When user-facing features change:
README updates
  • Updated README.md if feature overview affected
  • Updated README.zh-CN.md (Chinese version)
  • Updated feature list if new feature added
  • Updated screenshots/GIFs if UI changed significantly
Feature docs
  • Updated relevant docs/features/*.md file
  • Updated corresponding .zh-CN.md file
  • Added new feature doc if new feature (both languages)
  • Updated examples and usage instructions
  • Verified code samples are accurate
Cross-references
  • Updated links from README to feature docs
  • Updated internal cross-references in docs
  • Added new doc to docs/ index/TOC (if applicable)

Configuration Documentation Checklist

When configuration options change:
Configuration guide
  • Updated docs/configuration.md
  • Updated docs/configuration.zh-CN.md
  • Documented new environment variables
  • Documented new config file options
  • Updated config precedence order (if changed)
  • Updated default values
Example files
  • Updated .env.example (if env vars changed)
  • Updated config.example.yaml (if config file changed)
  • Updated docker-compose.example.yml (if Docker config changed)
Deployment docs
  • Updated skill-sublinkpro/reference/deploy.md if deployment-related
  • Updated Docker/install instructions if needed

API Documentation Checklist

When API endpoints change:
Skill API reference
  • Updated skill-sublinkpro/reference/api.md
  • Documented new endpoints
  • Updated changed endpoints
  • Marked deprecated endpoints
  • Updated request/response examples
  • Updated error codes and messages
  • Updated authentication requirements
Skill workflows
  • Updated skill-sublinkpro/SKILL.md if workflow affected
  • Updated usage examples
  • Updated error handling examples
Skill README
  • Updated skill-sublinkpro/README.md if needed
  • Updated skill-sublinkpro/README.zh-CN.md

Installation/Deployment Documentation Checklist

When installation or deployment changes:
Installation guide
  • Updated docs/installation.md
  • Updated docs/installation.zh-CN.md
  • Updated Docker installation steps
  • Updated docker-compose instructions
  • Updated one-line script instructions
  • Updated update/upgrade instructions
Deployment guide
  • Updated skill-sublinkpro/reference/deploy.md
  • Updated environment variable setup
  • Updated port mappings
  • Updated volume mounts
  • Updated default credentials
  • Updated security recommendations
Build process
  • Updated production build instructions (if changed)
  • Updated CI/CD documentation (if changed)

Developer Documentation Checklist

When developer workflows change:
Development guide
  • Updated docs/development.md
  • Updated docs/development.zh-CN.md
  • Updated local setup instructions
  • Updated validation commands
  • Updated testing instructions
  • Updated protocol extension guide (if protocol system changed)
Contributing guide
  • Updated CONTRIBUTING.md
  • Updated CONTRIBUTING.zh-CN.md
  • Updated branch conventions
  • Updated PR process
  • Updated testing requirements
Architecture guide
  • Updated AGENTS.md if architectural boundaries changed
  • Updated project structure documentation
  • Updated cross-layer sync requirements (if changed)
Theme/i18n guidelines
  • Updated docs/frontend-theme-guidelines.md + .zh-CN.md (if theme rules changed)
  • Updated docs/internationalization.md + .zh-CN.md (if i18n rules changed)

Bilingual Documentation Checklist

For every documentation change:
Both languages
  • Updated English canonical file (.md)
  • Updated Chinese translation file (.zh-CN.md)
  • Content semantically equivalent (not just machine-translated)
  • Examples work in both language contexts
Language switches
  • Language switch links at top of document work
  • Links use correct format: English | [简体中文](filename.zh-CN.md)
  • Chinese version links back: [English](filename.md) | 简体中文
  • Relative links work in both language files
  • Cross-references point to correct language variants
  • No broken links in either version

Documentation Map Updates

When documentation structure changes:
Adding new docs
  • Added new doc path to skill-sublinkpro/reference/docs.md
  • Added description/topic in the documentation map
  • Added both English and Chinese variants to map
Renaming/moving docs
  • Updated path in skill-sublinkpro/reference/docs.md
  • Updated all references in other docs
  • Verified old paths return 404 (on GitHub)
Show full SKILL.md (388 more words)Show less
Removing docs
  • Removed from skill-sublinkpro/reference/docs.md
  • Checked for incoming links from other docs
  • Redirected or updated incoming links

Code Examples in Documentation

When documenting code:
Accuracy
  • Code examples actually work
  • Commands match what exists in repo
  • File paths are correct
  • Configuration examples are valid
Completeness
  • Required context is provided
  • Output examples are realistic
  • Error handling shown where relevant
Maintenance
  • Examples use current API
  • Examples use current configuration format
  • Examples reflect current project structure

Common Documentation Files

Project-level
  • README.md / README.zh-CN.md - Project overview
  • CONTRIBUTING.md / CONTRIBUTING.zh-CN.md - How to contribute
  • CODE_OF_CONDUCT.md / CODE_OF_CONDUCT.zh-CN.md - Community standards
  • AGENTS.md - AI agent architectural guide
Core documentation
  • docs/installation.md / .zh-CN.md - Installation guide
  • docs/configuration.md / .zh-CN.md - Configuration reference
  • docs/development.md / .zh-CN.md - Developer guide
  • docs/internationalization.md / .zh-CN.md - i18n guidelines
  • docs/frontend-theme-guidelines.md / .zh-CN.md - Theme adaptation rules
Feature documentation
  • docs/features/*.md / .zh-CN.md - Feature-specific guides
  • docs/script_support.md / .zh-CN.md - Script support documentation
Skill documentation
  • skill-sublinkpro/SKILL.md - Skill definition
  • skill-sublinkpro/README.md / .zh-CN.md - Skill overview
  • skill-sublinkpro/reference/api.md - API reference
  • skill-sublinkpro/reference/deploy.md - Deployment guide
  • skill-sublinkpro/reference/docs.md - Documentation map

Verification Checklist

Before committing:
  • All internal links work (test by clicking in preview)
  • No broken references to code files
  • No references to removed/renamed files
  • Language switch links work
Formatting
  • Markdown renders correctly
  • Code blocks have correct syntax highlighting
  • Tables render properly
  • Lists and indentation correct
Consistency
  • Both language versions have same structure
  • Terminology consistent across docs
  • Examples match actual codebase
  • Commands match repo's actual commands

When Only Documentation Changed

Pure documentation commits:
No build required
  • ✅ No need to run yarn run lint or yarn run build
  • ✅ No need to run Go validation
Manual verification required
  • Links work
  • Both languages updated
  • Command examples accurate
  • No conflicts with AGENTS.md cross-layer rules

Documentation Anti-Patterns

Avoid these common mistakes:

  • ❌ Documenting commands that don't exist (yarn test when no test script)
  • ❌ Only updating English docs
  • ❌ Describing old behavior after code changed
  • ❌ Copy-pasting from generic templates without adapting
  • ❌ Leaving broken links
  • ❌ Documenting "future features" not yet implemented
  • ❌ Outdated screenshots showing old UI

Delivery Requirements

Before marking documentation changes complete:

  1. Bilingual verification: Both .md and .zh-CN.md updated
  2. Link verification: All links tested and working
  3. Accuracy verification: Examples/commands tested
  4. Consistency verification: No conflicts with code behavior

Exit Criteria

✅ Can exit when:

  • All affected documentation files updated
  • Both English and Chinese versions synchronized
  • Links verified
  • Examples tested
  • Code behavior matches documentation

❌ Cannot exit when:

  • Only one language updated
  • Documentation still describes old behavior
  • Broken links remain
  • Examples are inaccurate
  • New documentation not added to map

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

Files

Just SKILL.md in .agents/skills/doc-sync-check of ZeroDeng01/sublinkPro.

Open the folder on GitHubat commit 11479da

Compare with similar skills

Documentation Sync Check 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.

Documentation Sync Check compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Documentation Sync Check this skillZeroDeng01/sublinkPro1.7k—~2.6kAutomated safety check: PassMIT
Moonbit Docs Maintainermoonbitlang/moonbit-docs2.4k—~1.1kAutomated safety check: PassCustom licence
NeMo Curator Docs MaintenanceNVIDIA-NeMo/Curator1.8k—~4.3kAutomated safety check: PassApache-2.0
Opik Documentation Patternscomet-ml/opik22k—~1.3kAutomated safety check: PassApache-2.0
Technical Writerfinos/morphir213—~4.4kAutomated safety check: PassApache-2.0
Docs GuardamElnagdy/guard-skills1.3k—~2.1kAutomated safety check: PassMIT

Similar skills

  • Moonbit Docs Maintainer

    moonbitlang/moonbit-docs

    A skill your agent uses when maintaining the moonbitlang/moonbit-docs repository, including Sphinx docs under next/, MoonBit examples under next/sources/, error-code documentation, gettext…

    2.4k GitHub stars~1.1k tokensUpdated 16 days ago
    DevelopmentAuto-check passed

  • NeMo Curator Docs Maintenance

    NVIDIA-NeMo/Curator

    Adds, updates, moves and removes pages on the NeMo Curator Fern documentation site, keeping navigation entries, links and redirects in step.

    1.8k GitHub stars~4.3k tokensUpdated today
    DevelopmentAuto-check passed

  • Opik Documentation Patterns

    comet-ml/opik

    Rules for writing PR descriptions, changelog entries and feature documentation in the Opik repository, including the exact headings that CI requires.

    22k GitHub stars~1.3k tokensUpdated today
    DevelopmentAuto-check passed

  • Technical Writer

    finos/morphir

    Assists with writing and maintaining Morphir technical documentation.

    213 GitHub stars~4.4k tokensUpdated today
    DevelopmentAuto-check passed

  • Docs Guard

    amElnagdy/guard-skills

    Checks generated or edited documentation against the source code, flagging invented symbols, outdated samples and unverifiable claims before publishing.

    1.3k GitHub stars~2.1k tokensUpdated 3 mo ago
    DevelopmentAuto-check passed

  • Release Docs Sync

    UfoMiao/zcf

    Compares code changes since the last Git tag with the multilingual docs and CLAUDE.md, then updates them or only reports mismatches with --check-only.

    6.1k GitHub stars~4k tokensUpdated 1 mo ago
    DevelopmentAuto-check passed

More from ZeroDeng01/sublinkPro

All 8 skills in this repo

  • Performance Check

    ZeroDeng01/sublinkPro

    Checklist for reviewing code changes that touch queries, APIs, rendering, caching or algorithms for performance, scalability and resource-usage problems.

    1.7k GitHub stars~1.8k tokensUpdated 2 days ago
    Auto-check passed

  • Security Review Checklist

    ZeroDeng01/sublinkPro

    Checklist-driven security review for changes to authentication, authorization, MFA, secrets, input validation and other security-critical code.

    1.7k GitHub stars~2.3k tokensUpdated 2 days ago
    Auto-check passed

  • SublinkPro Manager

    ZeroDeng01/sublinkPro

    Manages a SublinkPro proxy subscription server through natural language, adding nodes, building subscriptions and share links, and editing templates and tags.

    1.7k GitHub stars~7.2k tokensUpdated 2 days ago
    Auto-check passed

  • Post-Development Workflow

    ZeroDeng01/sublinkPro

    A required checklist for after code changes: validate each changed layer, check that docs and other layers stay in sync, and test before committing or opening a PR.

    1.7k GitHub stars~4.4k tokensUpdated 2 days ago
    Auto-check passed

  • Pre-Commit Check Gate

    ZeroDeng01/sublinkPro

    Blocking checklist that runs formatting, lint and test commands for changed Go and frontend files before any git add, commit or pull request.

    1.7k GitHub stars~2.9k tokensUpdated 2 days ago
    Auto-check: notes

  • Theme Adaptation Checklist

    ZeroDeng01/sublinkPro

    A checklist for UI changes that touch colors, surfaces or theme code, making sure light and dark modes, devices, states and layering all still work.

    1.7k GitHub stars~1.4k tokensUpdated 2 days ago
    Auto-check passed

Categories

Questions about Documentation Sync Check

What does Documentation Sync Check do?

Checklist for keeping README, feature, configuration, install and API docs in step with code changes in the same PR, including the Chinese copies. Another workflow, post-dev-workflow, invokes this checklist when code changes affect documentation, and it is not meant to be called directly. The rule is that docs change in the same PR as the code.

When should I use Documentation Sync Check?

Documentation Sync Check fits situations like: finishing a change that adds or alters a configuration option or environment variable; updating docs after an API endpoint changes; checking that README and feature docs match a new user-facing feature in both languages.

How do I install Documentation Sync Check in Claude Code?

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

How do I install Documentation Sync Check in Codex?

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

Can I use Documentation Sync Check 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 ZeroDeng01/sublinkPro --skill doc-sync-check -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/doc-sync-check, .gemini/skills/doc-sync-check, .github/skills/doc-sync-check and .opencode/skills/doc-sync-check in your project.

What does Documentation Sync Check need to run?

Going by SKILL.md and its folder, Documentation Sync Check needs the command-line tools its instructions call (yarn). Our summary lists: The sublinkPro repository, including its AGENTS.md, CONTRIBUTING.md and docs folder.

Does Documentation Sync Check access the network?

SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.

Is Documentation Sync Check 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 Documentation Sync Check use?

Documentation Sync Check 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 Documentation Sync Check use?

About 2.6k tokens (SKILL.md is roughly 10k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to Documentation Sync Check?

Skills that share tags, products or a category with Documentation Sync Check: Moonbit Docs Maintainer (moonbitlang/moonbit-docs, 2.4k stars), NeMo Curator Docs Maintenance (NVIDIA-NeMo/Curator, 1.8k stars), Opik Documentation Patterns (comet-ml/opik, 22k stars) and Technical Writer (finos/morphir, 213 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Documentation Sync Check?

ZeroDeng01 (a GitHub user) maintains it in ZeroDeng01/sublinkPro, which has 1,665 GitHub stars. The repository holds 8 skills in this directory. The repository was last updated on October 5, 2026.

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