dartsim

dart-docs-update

"DART Docs Update: update docs or AI instruction visibility without code changes"

dartsim 1,196 304 Updated 1mo ago
GitHub

Install

npx skillscat add dartsim/dart/dart-docs-update

Install via the SkillsCat registry.

SKILL.md

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

  1. Create a branch from the target branch: git checkout -b docs/<topic> origin/main
  2. 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/**
  3. For AI workflow changes, run pixi run sync-ai-commands; do not hand-edit generated .opencode/ or .codex/ files
  4. 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.
  5. Update indexes and cross-references that point to changed docs
  6. Use docs/ai/verification.md to select the docs-only or AI docs/adapters
    gate set, then run pixi run lint before committing
  7. Invoke the dart-changelog routine for the CHANGELOG.md decision and any
    required entry.
  8. Ask for explicit maintainer/user approval before pushing or opening the PR.
    After approval, use .github/PULL_REQUEST_TEMPLATE.md and 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