Agent skill

Update Docs Workflow

by rodydavis in rodydavis/signals.dart

Review the current Jaspr docs, audit source code doc comments, edit the source code, and run the generator script to verify docs updates.

Apache-2.0Auto-check passedMobile

Install Update Docs Workflow

skills CLI
$ npx skills add rodydavis/signals.dart --skill update-docs-workflow -a claude-code

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

GitHub CLI
$ gh skill install rodydavis/signals.dart update-docs-workflow --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/rodydavis/signals.dart.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.agents/skills/update-docs-workflow .claude/skills/update-docs-workflow && 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-workflow
GitHub stars
819
Token cost
~810 tokens
SKILL.md length
336 words
Files
1
Skills in repo
15
Repo updated
First seen
Licence
Apache-2.0

At a glance

Review the current Jaspr docs, audit source code doc comments, edit the source code, and run the generator script to verify docs updates.

  • Works in 6 steps: Review Generated Markdown Docs → Trace to Source Declarations → Run the Programmatic Doc Comment Auditor → …
  • Tasks that involve Cross-platform mobile apps
  • SKILL.md covers Objective and 🛠️ Step-by-Step Workflow
  • Calls dart

What it does

Update Docs Workflow is an agent skill from rodydavis/signals.dart. Review the current Jaspr docs, audit source code doc comments, edit the source code, and run the generator script to verify docs updates.

Its SKILL.md is about 810 tokens, which your agent loads only when the skill is triggered. It is a single SKILL.md file with no bundled scripts.

It sits in Mobile, covering Cross-platform mobile apps and Technical documentation. It works with Dart, Flutter and Preact. The repository describes itself as: Reactive programming made simple for Dart and Flutter. The licence is Apache-2.0.

When your agent uses it

  • Tasks that involve Cross-platform mobile apps
  • Tasks that involve Technical documentation

Example prompts

  • “/update-docs-workflow”

Workflow steps

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

  1. Review Generated Markdown Docs
  2. Trace to Source Declarations
  3. Run the Programmatic Doc Comment Auditor
  4. Enrich Dart Source Code Comments
  5. Run the Documentation Generator
  6. Verify and Live Preview

What it can do on your machine

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

    • dart

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

  • Network

    No URLs in SKILL.md.

    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 Workflow loads about 810 tokens when it runs. Until then it costs about 40 tokens; SKILL.md has 336 words of instructions outside code blocks.

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

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 rodydavis/signals.dart at commit 81d64e8, republished under its Apache-2.0 licence (© rodydavis). 336 words, ~810 tokens.

Download SKILL.mdSave it as .claude/skills/update-docs-workflow/SKILL.md (or your agent's skills folder).
name
update-docs-workflow
description
Review the current Jaspr docs, audit source code doc comments, edit the source code, and run the generator script to verify docs updates.

Jaspr Documentation Audit and Regeneration Workflow

This skill provides a systematic and automated workflow to inspect generated Jaspr reference files, trace documentation back to its source Dart declarations, audit comments for completeness, enrich source comments with examples, and run the doc generator to verify static site updates.

Objective

Ensure all public APIs across the monorepo have high-quality, comprehensive documentation comments (///) with functional usage examples and clean styling without placeholders.

[!IMPORTANT] Focus exclusively on the docs/ directory and Jaspr documentation site. Completely ignore the website/ directory (which contains the legacy/alternative Astro configuration).


🛠️ Step-by-Step Workflow

Step 1. Review Generated Markdown Docs

Locate the generated reference markdown files under the Jaspr docs tree:

docs/content/packages/

For example, check if specific pages under preact_signals/, signals_core/, or signals_flutter/ are minimal, outdated, or contain empty blocks.

Step 2. Trace to Source Declarations

Use the declaration name and package context from the markdown file to locate the corresponding source file under the package’s source tree:

  • preact_signals: packages/preact_signals/lib/src/
  • signals_core: packages/signals_core/lib/src/
  • signals_flutter: packages/signals_flutter/lib/src/
  • signals_hooks: packages/signals_hooks/lib/src/
Step 3. Run the Programmatic Doc Comment Auditor

Execute the programmatic audit script to check for declarations lacking comments or examples:

bash
dart /Users/rodydavis/.gemini/antigravity/brain/5f607010-d7ba-40da-b166-4b3c433388c9/scratch/analyze_doc_comments.dart
Step 4. Enrich Dart Source Code Comments

Open the target source file and enrich the /// comments on classes, functions, and extensions using the following standards:

  • Comprehensive Explanations: Explain the reactive behavior, lazy calculation, memoization caching, or event subscription behaviors.
  • Comparative Code Examples: Show sequential vs batched updating behaviors (like in action.dart), or standard vs custom equality logic.
  • XML-Style Callouts: Use <Info>, <Warning>, <Error>, or <Success> XML tags inside comments rather than markdown triple-colon syntax (:::) to leverage Jaspr's custom callout components.
Step 5. Run the Documentation Generator

Regenerate all markdown files and search indices by executing:

bash
dart scripts/generate_docs.dart
Step 6. Verify and Live Preview
  1. Analyze: Run standard analysis on the docs package to check for any formatting warnings:
    bash
    dart analyze docs
  2. Build and Preview: Launch the Jaspr build/serve commands inside the docs/ folder:
    bash
    jaspr build
    Or run the development preview server:
    bash
    jaspr serve
    Open http://localhost:8080/ in the browser to visually inspect the updated docs and ensure everything renders beautifully.

© rodydavis, Apache-2.0. 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/update-docs-workflow of rodydavis/signals.dart.

Open the folder on GitHubat commit 81d64e8

Compare with similar skills

Update Docs Workflow 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 Workflow compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Update Docs Workflow this skillrodydavis/signals.dart819—~810Automated safety check: PassApache-2.0
Flutter Pub ReleaseMixinNetwork/flutter-plugins512—~1.3kAutomated safety check: PassMIT
Squadron Workerd-markey/squadron138—~1.6kAutomated safety check: PassMIT
Core API Changelibnativeapi/nativeapi157—~2.5kAutomated safety check: PassMIT
Layered ArchitectureVeryGoodOpenSource/vgv-ai-flutter-plugin169—~4.6kAutomated safety check: PassMIT
Flutter Dart Code Reviewaffaan-m/ECC274k2 repos~5.8kAutomated safety check: NotesMIT

Similar skills

  • Flutter Pub Release

    MixinNetwork/flutter-plugins

    Prepare and draft a pub.dev release for a package in the flutter-plugins monorepo.

    512 GitHub stars~1.3k tokensUpdated 1 mo ago
    MobileAuto-check passed
  • Squadron Worker

    d-markey/squadron

    A skill your agent uses when building, writing, or refactoring Squadron workers, worker pools, worker services, or using squadronbuilder annotations (@SquadronService, @SquadronMethod) for…

    138 GitHub stars~1.6k tokensUpdated 15 days ago
    MobileAuto-check passed
  • Core API Change

    libnativeapi/nativeapi

    Carry a change to the C++ public API in core/ all the way downstream — design check, header edit, six platform implementations, C ABI + Rust/Dart/C/JS/Python regeneration, per-binding verification…

    157 GitHub stars~2.5k tokensUpdated today
    MobileAuto-check passed
  • Layered Architecture

    VeryGoodOpenSource/vgv-ai-flutter-plugin

    VGV layered monorepo architecture in Flutter: four layers Data, Repository, Business Logic, and Presentation, unidirectional dependency rules, and model transformation across layers.

    169 GitHub stars~4.6k tokensUpdated yesterday
    MobileAuto-check passed
  • Library-agnostic Flutter/Dart code review checklist covering widget best practices, state management patterns (BLoC, Riverpod, Provider, GetX, MobX, Signals), Dart idioms, performance…

    274k GitHub starsUsed in 2 repos~5.8k tokens
    MobileAuto-check: notes
  • Executes long-running tasks in background isolates to keep the UI responsive.

    129 GitHub stars~1.8k tokensUpdated 9 days ago
    MobileAuto-check passed

More from rodydavis/signals.dart

All 15 skills in this repo
  • Jaspr Component Fundamentals

    rodydavis/signals.dart

    Teaches the agent Jaspr's Flutter-like component model and typed HTML elements, with strict rules on build methods and helper syntax.

    819 GitHub stars~1.8k tokensUpdated 23 days ago
    Auto-check passed
  • Jaspr CSS-in-Dart Styling

    rodydavis/signals.dart

    Guides styling of Jaspr web components with the type-safe Styles API in Dart, covering @css annotations, inline styles and global stylesheets.

    819 GitHub stars~1.7k tokensUpdated 23 days ago
    Auto-check passed
  • Jaspr JS Interop

    rodydavis/signals.dart

    Rules for calling JavaScript from Jaspr web apps in Dart: which interop libraries to import in server, static and client modes, and how to wrap functions, objects and libraries.

    819 GitHub stars~823 tokensUpdated 23 days ago
    Auto-check passed
  • Jaspr Pre-Rendering and Hydration

    rodydavis/signals.dart

    Sets the rules for static or server mode Jaspr apps in Dart, covering dual entrypoints, the client annotation and data hydration.

    819 GitHub stars~1.2k tokensUpdated 23 days ago
    Auto-check passed
  • Update Dart Examples Dependencies

    rodydavis/signals.dart

    Upgrades every package under ./examples to the repository's latest signals version, runs pub upgrade on third-party dependencies, and fixes the resulting analysis problems.

    819 GitHub stars~514 tokensUpdated 23 days ago
    Auto-check passed
  • Jaspr HTML Converter

    rodydavis/signals.dart

    Use when you need to convert / rewrite existing HTML (from a file or url) into Jaspr code.

    819 GitHub stars~378 tokensUpdated 23 days ago
    Auto-check passed

Questions about Update Docs Workflow

What does Update Docs Workflow do?

Review the current Jaspr docs, audit source code doc comments, edit the source code, and run the generator script to verify docs updates. dart. Review the current Jaspr docs, audit source code doc comments, edit the source code, and run the generator script to verify docs updates.

When should I use Update Docs Workflow?

Update Docs Workflow fits situations like: tasks that involve Cross-platform mobile apps; tasks that involve Technical documentation.

How do I install Update Docs Workflow in Claude Code?

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

How do I install Update Docs Workflow in Codex?

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

Can I use Update Docs Workflow 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 rodydavis/signals.dart --skill update-docs-workflow -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-workflow, .gemini/skills/update-docs-workflow, .github/skills/update-docs-workflow and .opencode/skills/update-docs-workflow in your project.

What does Update Docs Workflow need to run?

Going by SKILL.md and its folder, Update Docs Workflow needs the command-line tools its instructions call (dart).

Does Update Docs Workflow access the network?

SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.

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

Update Docs Workflow is published under the Apache-2.0 licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Update Docs Workflow use?

About 810 tokens (SKILL.md is roughly 3.2k 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 Workflow?

Skills that share tags, products or a category with Update Docs Workflow: Flutter Pub Release (MixinNetwork/flutter-plugins, 512 stars), Squadron Worker (d-markey/squadron, 138 stars), Core API Change (libnativeapi/nativeapi, 157 stars) and Layered Architecture (VeryGoodOpenSource/vgv-ai-flutter-plugin, 169 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Update Docs Workflow?

rodydavis (a GitHub user) maintains it in rodydavis/signals.dart, which has 819 GitHub stars. The repository holds 15 skills in this directory. The repository was last updated on September 14, 2026.

Source: rodydavis/signals.dart on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.