Agent skill

Docs Updater

by shenjingnan in shenjingnan/xiaozhi-client

“文档更新技能,用于批量更新文档和修复路径别名”

— description from SKILL.md by shenjingnan
MITAuto-check passedDevelopment

Install Docs Updater

skills CLI
$ npx skills add shenjingnan/xiaozhi-client --skill docs-updater -a claude-code

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

GitHub CLI
$ gh skill install shenjingnan/xiaozhi-client docs-updater --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/shenjingnan/xiaozhi-client.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.agents/skills/docs-updater .claude/skills/docs-updater && 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-updater
GitHub stars
341
Token cost
~664 tokens
SKILL.md length
130 words
Files
1
Skills in repo
16
Repo updated
First seen
Licence
MIT

At a glance

  • Works in 4 steps: 确定更新范围 - 根据参数确定要处理的文件范围 → 扫描并分析 - 识别需要修复的问题 → 执行修复 - 应用修复和更新 → …
  • SKILL.md covers 我的能力, 使用方式, 支持的更新类型 and 路径别名映射规则, plus 3 more sections
  • Calls pnpm and curl

About this skill

Docs Updater is a skill in shenjingnan/xiaozhi-client (341 stars). Its SKILL.md is about 664 tokens. Licence: MIT.

Workflow steps

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

  1. 确定更新范围 - 根据参数确定要处理的文件范围
  2. 扫描并分析 - 识别需要修复的问题
  3. 执行修复 - 应用修复和更新
  4. 验证结果 - 确保修复后文档正常工作

What it can do on your machine

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

    • pnpm
    • curl

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

  • Network

    No URLs in SKILL.md. Its commands use pnpm and curl, 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

Docs Updater loads about 664 tokens when it runs. Until then it costs about 9 tokens; SKILL.md has 130 words of instructions outside code blocks.

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

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 shenjingnan/xiaozhi-client at commit fe3c382, republished under its MIT licence (© shenjingnan). 130 words, ~664 tokens.

Download SKILL.mdSave it as .claude/skills/docs-updater/SKILL.md (or your agent's skills folder).
name
docs-updater
description
文档更新技能,用于批量更新文档和修复路径别名

文档更新技能

我是一个文档更新专家,专门批量更新现有文档内容并修复路径别名问题。

我的能力

当你需要更新现有文档时,我会:

  1. 确定更新范围 - 根据参数确定要处理的文件范围
  2. 扫描并分析 - 识别需要修复的问题
  3. 执行修复 - 应用修复和更新
  4. 验证结果 - 确保修复后文档正常工作

使用方式

使用格式:/docs-update [更新类型] [目标]

示例:

  • /docs-update path-aliases - 批量修复所有文档的路径别名
  • /docs-update path-aliases development/docker-build.mdx - 修复特定文件
  • /docs-update path-aliases usage/ - 修复整个目录
  • /docs-update code-examples typescript - 优化 TypeScript 代码示例
  • /docs-update format-fix getting-started/quickstart.mdx - 修复格式问题
  • /docs-update links-update internal - 更新内部链接

支持的更新类型

path-aliases - 路径别名修复
  • 作用范围:

    • 不指定参数:扫描所有 docs/ 下的 .mdx 和 .md 文件
    • 指定文件:更新特定文件
    • 指定目录:更新整个目录
  • 修复内容:

    • 将相对路径 ../ 和 ./ 替换为 @/xxx 格式
    • 识别代码块中的 import 语句
    • 确保路径别名符合 xiaozhi-client 项目规范
code-examples - 代码示例优化
  • 支持类型:typescript、javascript、bash
  • 优化内容:
    • 统一代码风格
    • 添加类型注解
    • 更新为最佳实践
format-fix - 格式修复
  • 修复内容:
    • MDX 语法错误
    • Markdown 格式问题
    • 代码块语法高亮
    • 表格格式修正
  • 更新类型:internal、external、images
  • 检查内容:
    • 链接有效性
    • 链接文本准确性
    • 锚点正确性

路径别名映射规则

基于 xiaozhi-client 项目的路径别名系统:

typescript
// xiaozhi-client 项目别名映射(单体架构,统一 @/ 路径别名体系)
{
  "@/types":    ["./src/types"],      // 共享类型定义
  "@/config":   ["./src/config"],     // 配置管理
  "@/mcp-core": ["./src/mcp-core"],   // MCP 协议核心
  "@/endpoint": ["./src/endpoint"],   // 端点处理
  "@/esp32":    ["./src/esp32"],      // ESP32 硬件相关
  "@/cli":      ["./src/cli"],        // CLI 命令行工具
  "@/utils":    ["./src/utils"],      // 通用工具
  "@/server":   ["./src/server"]      // 后端服务(含 handlers、services、routes 等)
}

常见修复模式

typescript
// ❌ 需要修复的相对路径
import { Service } from "../services/file";
import { Command } from "./commands/help";
import { Type } from "../../types/interface";
import { util } from "./utils/helper";

// ✅ 修复后的别名路径(xiaozhi-client @/ 路径别名体系)
import { Service } from "@/server/services/file";
import { Command } from "@/cli/commands/start";
import { Type } from "@/types/interface";
import { util } from "@/utils/helper";

更新流程

扫描阶段
  1. 识别目标文件:根据参数确定要处理的文件范围
  2. 内容分析:解析 MDX 文件,提取代码块
  3. 问题识别:检测需要修复的问题
修复阶段
  1. 路径别名修复:替换相对路径为别名格式
  2. 代码示例优化:改进代码质量和风格
  3. 格式修正:修复 MDX 语法和格式问题
验证阶段
bash
# 本地验证流程
pnpm dev:docs

# 等待服务启动后检查状态
curl -s -o /dev/null -w "%{http_code}" http://localhost:3000

# 运行代码质量检查
pnpm spellcheck
pnpm lint
pnpm typecheck

注意事项

例外情况

以下相对路径使用是合理的,不会被自动修复:

  • 同一目录下的紧密相关模块
  • 测试文件对被测试文件的引用
  • 动态导入路径
手动确认

对于复杂或不确定的修复:

  • 标记需要手动确认的修复项
  • 提供修复建议和理由
  • 等待用户确认后再应用

© shenjingnan, 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/docs-updater of shenjingnan/xiaozhi-client.

Open the folder on GitHubat commit fe3c382

Compare with similar skills

Docs Updater 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 Updater compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Docs Updater this skillshenjingnan/xiaozhi-client341—~664Automated safety check: PassMIT
Typescript Advanced Typesrolling-scopes/rsschool-app10k25 repos~4.2kAutomated safety check: PassMPL-2.0
Code Review ChecklistshareAI-lab/learn-claude-code78k4 repos~1.1kAutomated safety check: PassMIT
Nx Importnrwl/nx29k6 repos~3.5kAutomated safety check: PassMIT
Install Anti-Slop Oxlint Rulesdmmulroy/anti-slop5.4k—~2.2kAutomated safety check: PassMIT
OpenTUI Terminal Interfacescline/cline70k—~1.9kAutomated safety check: PassApache-2.0

Similar skills

  • Typescript Advanced Types

    rolling-scopes/rsschool-app

    Master TypeScript's advanced type system including generics, conditional types, mapped types, template literals, and utility types for building type-safe applications.

    10k GitHub starsUsed in 25 repos~4.2k tokens
    DevelopmentAuto-check passed
  • Code Review Checklist

    shareAI-lab/learn-claude-code

    Reviews code against a five-part checklist covering security, correctness, performance, maintainability and testing, and reports findings in a fixed format.

    78k GitHub starsUsed in 4 repos~1.1k tokens
    DevelopmentAuto-check passed
  • Nx Import

    nrwl/nx

    Import, merge, or combine repositories into an Nx workspace using nx import.

    29k GitHub starsUsed in 6 repos~3.5k tokens
    DevelopmentAuto-check passed
  • Installs, updates or migrates the vendored anti-slop Oxlint plugin in a repository, keeping local rule changes and the plugin's license and provenance files.

    5.4k GitHub stars~2.2k tokensUpdated 1 mo ago
    DevelopmentAuto-check passed
  • Helps build terminal user interfaces with OpenTUI using its core imperative API or its React and Solid reconcilers, with references for layout, keyboard, animation and testing.

    70k GitHub stars~1.9k tokensUpdated today
    DevelopmentAuto-check passed
  • Frontend Code Review

    langgenius/dify

    Reviews frontend changes under `web/` or `packages/dify-ui/` for concrete defects and broken project contracts, using routed rule packs and a severity scale for findings.

    158k GitHub stars~938 tokensUpdated today
    DevelopmentAuto-check passed

More from shenjingnan/xiaozhi-client

All 16 skills in this repo
  • E2E Coverage Analyzer

    shenjingnan/xiaozhi-client

    分析当前分支 git 改动,检查 e2e 测试用例覆盖情况,并可补充缺失的测试用例. An agent skill from shenjingnan/xiaozhi-client.

    341 GitHub stars~954 tokensUpdated 1 mo ago
    Auto-check passed
  • Fix Comment

    shenjingnan/xiaozhi-client

    GitHub 评论修复技能,用于获取 PR 的 Copilot 评论并分析修复问题. An agent skill from shenjingnan/xiaozhi-client.

    341 GitHub stars~873 tokensUpdated 1 mo ago
    Auto-check passed
  • API Docs

    shenjingnan/xiaozhi-client

    文档自动生成

    341 GitHub stars~2.4k tokensUpdated 1 mo ago
    Auto-check passed
  • CI Validator

    shenjingnan/xiaozhi-client

    CI检查验证和质量保障

    341 GitHub stars~2.1k tokensUpdated 1 mo ago
    Auto-check passed
  • Commit

    shenjingnan/xiaozhi-client

    生成代码评审友好的 commit 信息

    341 GitHub stars~1.4k tokensUpdated 1 mo ago
    Auto-check passed
  • Dev Workflow Checker

    shenjingnan/xiaozhi-client

    开发流程检查技能,确保代码修改后执行必要的质量检查

    341 GitHub stars~464 tokensUpdated 1 mo ago
    Auto-check passed

Works with

Categories

Questions about Docs Updater

How do I install Docs Updater in Claude Code?

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

How do I install Docs Updater in Codex?

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

Can I use Docs Updater 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 shenjingnan/xiaozhi-client --skill docs-updater -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-updater, .gemini/skills/docs-updater, .github/skills/docs-updater and .opencode/skills/docs-updater in your project.

What does Docs Updater need to run?

Going by SKILL.md and its folder, Docs Updater needs the command-line tools its instructions call (pnpm and curl).

Does Docs Updater access the network?

SKILL.md contains no URLs. Its commands use curl, which can reach the network depending on how they are called. This is read from the text; nothing was executed.

Is Docs Updater 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 Updater use?

Docs Updater 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 Updater use?

About 664 tokens (SKILL.md is roughly 2.7k 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 Docs Updater?

Skills that share tags, products or a category with Docs Updater: Typescript Advanced Types (rolling-scopes/rsschool-app, 10k stars), Code Review Checklist (shareAI-lab/learn-claude-code, 78k stars), Nx Import (nrwl/nx, 29k stars) and Install Anti-Slop Oxlint Rules (dmmulroy/anti-slop, 5.4k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Docs Updater?

shenjingnan (a GitHub user) maintains it in shenjingnan/xiaozhi-client, which has 341 GitHub stars. The repository holds 16 skills in this directory. The repository was last updated on September 3, 2026.

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