Agent Skills
› dartsim/dart
› dart-docs-update
dart-docs-update
GitHub用于更新 DART 项目的文档和 AI 指令可见性，不涉及代码变更。通过创建分支、编辑文档源文件、同步 AI 命令、验证分类与索引、运行 lint 检查及处理变更日志，最终在获得批准后提交 PR。
触发场景
需要更新项目文档或 README
调整 AI 工作流指令的可见性或结构
维护文档信息架构与索引
安装
npx skills add dartsim/dart --skill dart-docs-update -g -y
SKILL.md
Frontmatter
{
"name": "dart-docs-update",
"description": "DART Docs Update: update docs or AI instruction visibility without code changes"
}
dart-docs-update
Use this skill in Codex to run the DART dart-docs-update workflow. The editable
workflow source lives in .claude/commands/; this file is its generated adapter
in the shared .agents/skills/ catalog.
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/AGENTS.md @docs/information-architecture.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, andCHANGELOG.mdwhendart-changelogrequires a release-note entry - AI source files:
.claude/commands/**,.claude/skills/**
- Regular docs:
- For AI workflow changes, run
pixi run sync-ai-commands; do not hand-edit generated.opencode/or.codex/files - Classify new or moved docs by lifecycle first, then audience, then topic,
using
docs/information-architecture.md. For AI docs, keep always-loaded entrypoints compact: improve owner placement or pointers instead of duplicating procedures. - Update indexes and cross-references that point to changed docs
- Use
docs/ai/verification.mdto select the docs-only or AI docs/adapters gate set, then runpixi run lintbefore committing - Invoke the
dart-changelogroutine for theCHANGELOG.mddecision and any required entry. - Ask for explicit maintainer/user approval before pushing or opening the PR.
After approval, use
.github/PULL_REQUEST_TEMPLATE.mdand the proper milestone.
Output
- Docs and AI workflow sources changed
- Sync and verification commands run
- Changelog decision
- PR readiness, noting any external mutation that was explicitly approved
版本历史
- b9fbefc 当前 2026-07-19 11:29
