Agent Skills › dartsim/dart › dart-docs-update

dart-docs-update

GitHub

用于更新 DART 项目文档及 AI 工作流配置的技能。支持在仅修改文档源文件的前提下，执行分支创建、内容编辑、索引同步、代码检查及变更日志决策，最终生成待审核的 PR，确保文档与代码分离维护。

.codex/skills/dart-docs-update/SKILL.md dartsim/dart

Trigger Scenarios

用户请求更新项目文档需要修改 .claude/commands 或 skills 等 AI 工作流源码运行 /dart-docs-update 命令

Install

npx skills add dartsim/dart --skill dart-docs-update -g -y

More Options

Non-standard path

npx skills add https://github.com/dartsim/dart/tree/main/.codex/skills/dart-docs-update -g -y

Use without installing

npx skills use dartsim/dart@dart-docs-update

指定 Agent (Claude Code)

npx skills add dartsim/dart --skill dart-docs-update -a claude-code -g -y

安装 repo 全部 skill

npx skills add dartsim/dart --all -g -y

预览 repo 内 skill

npx skills add dartsim/dart --list

SKILL.md

Frontmatter

{
    "name": "dart-docs-update",
    "description": "DART Docs Update: update documentation without code changes"
}

dart-docs-update

Use this skill in Codex to run the DART dart-docs-update workflow. The editable workflow source currently lives in .claude/commands/, and this generated Codex skill is a first-class Codex entrypoint.

Invocation

Claude Code/OpenCode: /dart-docs-update <arguments>
Codex: $dart-docs-update <arguments>

Treat the text after the skill name as $ARGUMENTS. When the workflow references $1, $2, etc., map those to the positional values supplied by the user.

Command Body

Update documentation: $ARGUMENTS

Required Reading

@AGENTS.md @docs/README.md @docs/ai/principles.md @docs/ai/verification.md @docs/onboarding/ai-tools.md @docs/onboarding/changelog.md

Workflow

Create a branch from the target branch: git checkout -b docs/<topic> origin/main
Edit docs and AI workflow sources only:
- Regular docs: docs/**, README.md, AGENTS.md, CONTRIBUTING.md, and CHANGELOG.md when dart-changelog requires a release-note entry
- AI source files: .claude/commands/**, .claude/skills/**
For AI workflow changes, run pixi run sync-ai-commands; do not hand-edit generated .opencode/ or .codex/ files
Update indexes and cross-references that point to changed docs
Use docs/ai/verification.md to select the docs-only or AI docs/adapters gate set, then run pixi run lint before committing
Invoke the dart-changelog routine for the CHANGELOG.md decision and any required entry.
Ask for explicit maintainer/user approval before pushing or opening the PR. After approval, use .github/PULL_REQUEST_TEMPLATE.md and the proper milestone.