Agent skill

Update Docs PR

by opentiny in opentiny/genui-sdk

After publishing a new @opentiny/genui-sdk package, update opentiny/docs (submodule, genui package versions, VitePress sidebar) and opentiny/opentiny.design (submodule commit only), then open PRs on…

MITAuto-check passedFrontend & Design

Install Update Docs PR

skills CLI
$ npx skills add opentiny/genui-sdk --skill update-docs-pr -a claude-code

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

GitHub CLI
$ gh skill install opentiny/genui-sdk update-docs-pr --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/opentiny/genui-sdk.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.agents/skills/update-docs-pr .claude/skills/update-docs-pr && 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
update-docs-pr
GitHub stars
171
Token cost
~819 tokens
SKILL.md length
169 words
Files
4
Skills in repo
5
Repo updated
First seen
Licence
MIT

At a glance

After publishing a new @opentiny/genui-sdk package, update opentiny/docs (submodule, genui package versions, VitePress sidebar) and opentiny/opentiny.design (submodule commit only), then open PRs on…

  • Works in 3 steps: :确定 version 与 COMMIT → 4 → :回报
  • The user asks to 更新文档工程
  • SKILL.md covers 前置检查, 工作流 and 常见问题
  • Calls gh and brew

What it does

Update Docs PR is an agent skill from opentiny/genui-sdk. After publishing a new @opentiny/genui-sdk package, update opentiny/docs (submodule, genui package versions, VitePress sidebar) and opentiny/opentiny.design (submodule commit only), then open PRs on branch deploy/update-genui-{version}. Use when the user asks to 更新文档工程 or 更新官网工程 or sync docs, update opentiny/docs or opentiny.design, or create deploy PRs after a genui-sdk release.

Its SKILL.md is about 820 tokens, which your agent loads only when the skill is triggered. The skill folder holds 3 other files (for example `deploy.md`, `design.md` and `docs.md`).

It sits in Frontend & Design, covering Static sites and blogs. It works with VitePress and npm. The repository describes itself as: A Generative UI SDK for Vue, Angular and React. The licence is MIT.

When your agent uses it

  • The user asks to 更新文档工程
  • Update opentiny/docs
  • Opentiny.design
  • Create deploy PRs after a genui-sdk release

Example prompts

  • “/update-docs-pr”

Requirements

  • Node.js

Workflow steps

3 steps, taken from the step headings in SKILL.md.

  1. :确定 version 与 COMMIT
  2. 4
  3. :回报

What it can do on your machine

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

    • gh
    • brew

    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):

    • github.com
    • opentiny.github.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

Update Docs PR loads about 819 tokens when it runs. Until then it costs about 99 tokens; SKILL.md has 169 words of instructions outside code blocks.

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

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 opentiny/genui-sdk at commit 69578e3, republished under its MIT licence (© opentiny). 169 words, ~819 tokens.

Download SKILL.mdSave it as .claude/skills/update-docs-pr/SKILL.md (or your agent's skills folder). This skill also uses 3 other files; get the full folder from GitHub.
name
update-docs-pr
description
After publishing a new @opentiny/genui-sdk package, update opentiny/docs (submodule, genui package versions, VitePress sidebar) and opentiny/opentiny.design (submodule commit only), then open PRs on branch deploy/update-genui-{version}. Use when the user asks to 更新文档工程 or 更新官网工程 or sync docs, update opentiny/docs or opentiny.design, or create deploy PRs after a genui-sdk release.

Update docs & opentiny.design PRs

发布 genui-sdk 新版本后,更新以下仓库并自动提 PR:

不要 clone 整仓。 一律用 gh api。禁止 force-push;后续修改在分支上追加 commit。

前置检查

  1. 依赖:需要 gh(GitHub CLI)、jq(解析 API 输出)、npm(docs 查 npm 最新版本用)。先检查:
    bash
    command -v gh >/dev/null || { echo "gh 未安装,请先安装:brew install gh" >&2; exit 1; }
    command -v jq >/dev/null || { echo "jq 未安装,请先安装:brew install jq" >&2; exit 1; }
    command -v npm >/dev/null || { echo "npm 未安装,请先安装 Node.js(含 npm)" >&2; exit 1; }
    缺失时给安装指引(macOS:brew install gh jq;npm 随 Node.js 一起安装),不要当作未登录去提示 gh auth login。
  2. 版本号:用户提供(如 1.3.0 / v1.3.0),去前导 v;须为非空 semver(含预发布/构建号),非法值直接退出。opentiny.design 不写版本,只共用 COMMIT。
  3. 鉴权:gh auth status;未登录则提示 gh auth login 或提供对两仓有写权限的 token。
text
COMMIT = 用户指定,否则 opentiny/genui-sdk 远程 main tip
BRANCH = deploy/update-genui-{version}
基线分支(两仓)= dev

工作流

text
进度:
- [ ] 1. 确定 version 与 COMMIT
- [ ] 2. 更新 opentiny/docs 并提 PR        → docs.md
- [ ] 3. 更新 opentiny/opentiny.design 并提 PR → design.md
- [ ] 4. 触发 Pages 部署,成功后打开预览   → deploy.md
- [ ] 5. 回报 PR URL、run URL、预览 URL
Step 1:确定 version 与 COMMIT
bash
version="${version#v}"
if [ -z "${version}" ] || ! [[ "${version}" =~ ^[0-9]+\.[0-9]+\.[0-9]+(-[0-9A-Za-z.-]+)?(\+[0-9A-Za-z.-]+)?$ ]]; then
  echo "version required (semver, e.g. 1.3.0)" >&2
  exit 1
fi

if [ -n "${USER_COMMIT}" ]; then
  COMMIT="${USER_COMMIT}"
else
  COMMIT=$(gh api repos/opentiny/genui-sdk/git/ref/heads/main --jq .object.sha) || {
    echo "获取 genui-sdk main tip 失败,请检查网络与鉴权" >&2
    exit 1
  }
fi
if ! [[ "${COMMIT}" =~ ^[0-9a-fA-F]{40}$ ]]; then
  echo "COMMIT 无效:需为 40 位 hex SHA,当前为 ${COMMIT}" >&2
  exit 1
fi
BRANCH="deploy/update-genui-${version}"
  • version:用户输入并去前导 v;用于分支名与 PR 文案;docs 里各 genui 依赖分别取各自 npm 最新正式版(见 docs.md)
  • COMMIT:优先用户指定;否则 main tip;两仓共用;解析失败或非 40 位 hex SHA 直接退出;勿再用 tag 覆盖用户指定的 commit
Step 2–4

按顺序执行并阅读对应文件中的命令与规则:

  1. docs.md
  2. design.md
  3. deploy.md
Step 5:回报

返回 docs / design 的 PR URL、部署 run URL,以及:

一仓失败时尽量完成另一仓,并说明原因。

常见问题

情况处理
gh / jq / npm 未安装按前置检查安装(macOS:brew install gh jq;npm 随 Node.js),不要当作未登录
未登录 / 无权限gh auth login 或提供覆盖两仓的 token
分支已存在 / 改 PR以分支 tip 为 parent 追加 commit,无 force PATCH
用户指定了 commit两仓都用该 commit
docs 无侧栏变更跳过 config.mts
design只动 genui-sdk gitlink
部署失败回报 run URL,不要打开过期预览
打不开浏览器把预览 URL 发给用户

© opentiny, 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 3 other files in .agents/skills/update-docs-pr of opentiny/genui-sdk.

  • SKILL.md
  • deploy.md
  • design.md
  • docs.md

Open the folder on GitHubat commit 69578e3

Compare with similar skills

Update Docs PR 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.

Update Docs PR compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Update Docs PR this skillopentiny/genui-sdk171—~819Automated safety check: PassMIT
Oryxos Admin UIoryx-labs/oryxos187—~913Automated safety check: PassApache-2.0
Vitepress Skilldskilld-dev/vue-ecosystem-skills181—~1.7kAutomated safety check: PassMIT
Docs Managementbkywksj/knowledge-base330—~2.5kAutomated safety check: PassCustom licence
Create Docsvictorgarciaesgi/nuxt-typed-router4132 repos~2.8kAutomated safety check: PassMIT
Rocketmodernweb-dev/rocket395—~536Automated safety check: PassMIT

Similar skills

  • Oryxos Admin UI

    oryx-labs/oryxos

    生成或扩展 OryxOS 的 Web 管理台(web manager)前端——Vue 3 + Vite 单页应用,视觉与官网首页 (website/,VitePress)完全同源:深色底 + 橙色主色、Inter/JetBrains Mono。内置这套设计 token、 工程约定(base '/admin/'、产物落 oryxos-web static/admin、SPA…

    187 GitHub stars~913 tokensUpdated yesterday
    Frontend & DesignAuto-check passed
  • Vitepress Skilld

    skilld-dev/vue-ecosystem-skills

    A skill your agent uses when writing, configuring, or debugging code that imports "vitepress", when running vitepress CLI commands, editing .vitepress/config or theme files, tuning markdown or…

    181 GitHub stars~1.7k tokensUpdated 15 days ago
    Frontend & DesignAuto-check passed
  • Docs Management

    bkywksj/knowledge-base

    VitePress 文档站点管理技能。负责初始化文档站点、增量同步代码变更到文档、追踪同步元数据(.docs-meta.json),生成的文档风格模仿同目录 tauri-docs / tauri-cc-docs / knowledge-base-docs。

    330 GitHub stars~2.5k tokensUpdated 5 days ago
    Knowledge ManagementAuto-check passed
  • Create Docs

    victorgarciaesgi/nuxt-typed-router

    Create complete documentation sites for projects. An agent skill from victorgarciaesgi/nuxt-typed-router.

    413 GitHub starsUsed in 2 repos~2.8k tokens
    Frontend & DesignAuto-check passed
  • Rocket

    modernweb-dev/rocket

    A skill your agent uses when editing Rocket Pages, config, layouts, component reference Pages, or build behavior in this project.

    395 GitHub stars~536 tokensUpdated 9 days ago
    Frontend & DesignAuto-check passed
  • Sync Docs

    eslint-config/airbnb-extended

    Check that the VitePress docs in docs/ match the real exports, rules and CLI options in the code, then fix any drift.

    129 GitHub stars~878 tokensUpdated yesterday
    Frontend & DesignAuto-check passed

More from opentiny/genui-sdk

  • Release Notes

    opentiny/genui-sdk

    Generate and publish formatted GitHub Release Notes for opentiny/genui-sdk.

    171 GitHub stars~1.4k tokensUpdated 2 days ago
    Auto-check passed
  • Genui Integration

    opentiny/genui-sdk

    genui-sdk 全方位指南:安装、配置、集成、示例。用户提到 genui-sdk、genui-sdk-server,或想构建 AI 聊天界面、动态 UI 组件、Node.js 后端 LLM 代理(OpenAI 兼容 chat/completions API)时使用。涵盖 Vue/Angular 前端(主题、物料、GenuiChat/GenuiRenderer)与 Server…

    171 GitHub stars~1.3k tokensUpdated 2 days ago
    Auto-check passed
  • Docs I18n

    opentiny/genui-sdk

    Sync GenUI SDK docs between Chinese and English when adding, editing, renaming, or deleting documentation under docs/.

    171 GitHub stars~962 tokensUpdated 2 days ago
    Auto-check passed
  • Publicity Article

    opentiny/genui-sdk

    Write GenUI SDK version publicity articles for 掘金, 公众号, and other platforms from release notes.

    171 GitHub stars~1.1k tokensUpdated 2 days ago
    Auto-check passed

Works with

Questions about Update Docs PR

What does Update Docs PR do?

After publishing a new @opentiny/genui-sdk package, update opentiny/docs (submodule, genui package versions, VitePress sidebar) and opentiny/opentiny.design (submodule commit only), then open PRs on…. Update Docs PR is an agent skill from opentiny/genui-sdk.design (submodule commit only), then open PRs on branch deploy/update-genui-{version}.

When should I use Update Docs PR?

Update Docs PR fits situations like: the user asks to 更新文档工程; update opentiny/docs; opentiny.design; create deploy PRs after a genui-sdk release.

How do I install Update Docs PR in Claude Code?

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

How do I install Update Docs PR in Codex?

Run `npx skills add opentiny/genui-sdk --skill update-docs-pr -a codex`. Or copy the skill folder (.agents/skills/update-docs-pr in opentiny/genui-sdk) into .agents/skills/update-docs-pr in your project. Codex loads it when a task matches its description.

Can I use Update Docs PR 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 opentiny/genui-sdk --skill update-docs-pr -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/update-docs-pr, .gemini/skills/update-docs-pr, .github/skills/update-docs-pr and .opencode/skills/update-docs-pr in your project.

What does Update Docs PR need to run?

Going by SKILL.md and its folder, Update Docs PR needs the command-line tools its instructions call (gh and brew). Our summary lists: Node.js.

Does Update Docs PR access the network?

SKILL.md names 2 domains. As links in the text: github.com and opentiny.github.io. This is read from the text; nothing was executed.

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

Update Docs PR 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 Update Docs PR use?

About 819 tokens (SKILL.md is roughly 3.3k 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 Update Docs PR?

Skills that share tags, products or a category with Update Docs PR: Oryxos Admin UI (oryx-labs/oryxos, 187 stars), Vitepress Skilld (skilld-dev/vue-ecosystem-skills, 181 stars), Docs Management (bkywksj/knowledge-base, 330 stars) and Create Docs (victorgarciaesgi/nuxt-typed-router, 413 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Update Docs PR?

opentiny (a GitHub organization) maintains it in opentiny/genui-sdk, which has 171 GitHub stars. The repository holds 5 skills in this directory. The repository was last updated on October 5, 2026.

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