Update Docs Workflow

Community

rodydavis

update-docs-workflow

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

Overview

Publisher	rodydavis
Repository	`signals.dart`
Skill name	`update-docs-workflow`
Stars	820
Forks	86
Bundled files	Instructions only
License	Apache-2.0
Links	Skill source Repository Homepage

Markdown instructions
A SKILL.md file the model loads on demand, so it only costs tokens when a request actually matches.
Works with any LLM
AI skills are plain Markdown, not provider-specific code, so this works with GPT, Claude, Gemini, Grok, or a local model.
Self-contained
Everything the model needs lives in the instructions — no extra files to sync.
Open source
Published by rodydavis on GitHub. Read the source before you install it.

Installation

Install the Update Docs Workflow AI skill in TypingMind to use it with any LLM, or drop it into another agent that reads SKILL.md.

Install in TypingMind

TypingMind installs a skill straight from its GitHub folder — it reads SKILL.md, bundles the resource files, and stores the result locally.

Open the app and go to Plugins → Skills.
Choose "Install from GitHub".
Paste the skill folder URL below and confirm.
https://github.com/rodydavis/signals.dart/tree/main/.agents/skills/update-docs-workflow
Enable the skill in any chat where you want it available.

Plugins → Skills → Add skill → From GitHub URL, then paste the folder URL and press Continue.

Install in another agent

Any agent that reads the Agent Skills format can use this skill — copy the folder into that agent's skills directory.

Claude Code — .claude/skills

git clone --depth 1 https://github.com/rodydavis/signals.dart.git /tmp/signals.dart
mkdir -p .claude/skills
cp -r /tmp/signals.dart/.agents/skills/update-docs-workflow .claude/skills/update-docs-workflow

Restart Claude Code after copying so it picks up the new skill.

Use it in TypingMind

Enable Update Docs Workflow in any TypingMind chat and the model takes it from there. Its name and description sit in the system prompt, and the moment a request matches, the model loads the full instructions itself — you never invoke it by hand, and it costs no tokens until it is actually used.

The model loads Update Docs Workflow on its own as soon as a request matches it.

Works with any AI model

AI skills are plain Markdown instructions rather than provider-specific code, so Update Docs Workflow is not tied to the model it was written for. Install it once in TypingMind and use it with GPT-5, Claude, Gemini, Grok, DeepSeek, Mistral, Llama, or a local model you run yourself — all on your own API keys.

Loaded only when it is needed
The system prompt carries just the name and description. The instructions are fetched on the first matching request, so an idle skill costs nothing.
Switch models mid-chat
Because the skill is instructions rather than code, changing model does not break it — the next model reads the same SKILL.md.

Skill instructions

This is the SKILL.md content the model loads. Read it before installing — a skill is instructions your model will follow.

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

Analyze: Run standard analysis on the docs package to check for any formatting warnings:
```
bash
dart analyze docs
```
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.

Frequently asked questions

What does the Update Docs Workflow AI skill do?

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

Why use Update Docs Workflow on TypingMind?

Because you install it once and use it with any model. Update Docs Workflow is plain Markdown rather than provider-specific code, so the same skill runs on GPT-5, Claude, Gemini, Grok, or a local model — and you can switch model mid-chat without it breaking. TypingMind runs on your own API keys, so you pay providers directly instead of a per-seat subscription, and your skills and chats stay in your own storage.

How do I install Update Docs Workflow in TypingMind?

Open Plugins → Skills → Install from GitHub in TypingMind and paste https://github.com/rodydavis/signals.dart/tree/main/.agents/skills/update-docs-workflow. TypingMind reads its SKILL.md and installs it as a skill you can enable per chat.

Which AI models can use Update Docs Workflow?

Any model you connect in TypingMind. AI skills are plain Markdown instructions rather than provider-specific code, so GPT, Claude, Gemini, Grok, and local models can all load this skill when a request matches it.

How many AI models can I use with Update Docs Workflow?

As many as you like. As long as a model supports skills, you can use Update Docs Workflow with it — GPT, Claude, Gemini, Grok, DeepSeek, Mistral, Llama and more — all on TypingMind with your own API keys.

Is the Update Docs Workflow AI skill free?

Yes. It is published on GitHub by rodydavis under the Apache-2.0 license. You only pay your own AI provider for the tokens you use.

What are AI skills?

An AI skill is a reusable instruction bundle that teaches an AI model how to do one specific task. It follows the open Agent Skills format: a SKILL.md file with a name and description, plus any scripts, templates or reference files the model may need. The model reads the instructions only when your request matches the skill, so an installed skill costs nothing until it is used.

How are AI skills different from plugins or MCP servers?

A plugin or MCP server gives a model new tools to call — code that runs somewhere and returns a result. An AI skill gives the model knowledge and process instead: how to approach a task, which steps to follow, what good output looks like. Skills are plain Markdown, so they need no server, no API key and no runtime, and they work with any model.

View all

Brand Discovery

affaan-m

CommunityPopular

Use when a brand needs to discover or articulate its identity through structured multi-session interviews. Covers purpose, positioning, audience, personality, voice, narrative, and founder-brand…

Bun Runtime

Bun as runtime, package manager, bundler, and test runner. When to choose Bun vs Node, migration notes, and Vercel support.

Competitive Report Structure

affaan-m

CommunityPopular

Use after benchmark-methodology has produced scored competitor profile cards. Assembles findings into a decision-grade report: landscape map, competitor profiles, benchmarking matrix, white-space…

Content Engine

Create platform-native content systems for X, LinkedIn, TikTok, YouTube, newsletters, and repurposed multi-platform campaigns. Use when the user wants social posts, threads, scripts, content…

Overview

Installation

Install in TypingMind

Install in another agent

Use it in TypingMind

Works with any AI model

Skill instructions

Jaspr Documentation Audit and Regeneration Workflow

Objective

🛠️ Step-by-Step Workflow

Step 1. Review Generated Markdown Docs

Step 2. Trace to Source Declarations

Step 3. Run the Programmatic Doc Comment Auditor

Step 4. Enrich Dart Source Code Comments

Step 5. Run the Documentation Generator

Step 6. Verify and Live Preview

Frequently asked questions

Related AI Skills

Set up your own AI workspace now