update-docs-workflow

What problem does it solve?

It prevents stale or incomplete Jaspr reference documentation by auditing generated markdown, tracing issues back to Dart declarations, improving doc comments, and regenerating the site.

Core Features & Use Cases

• Docs completeness audit: Detects public declarations that lack adequate /// comments or examples.
• Source-to-reference tracing: Maps generated docs/content/packages/ pages back to the corresponding Dart sources across packages (e.g., preact_signals, signals_core, signals_flutter).
• Comment enrichment standards: Improves explanations with functional behavior details and uses Jaspr-friendly XML-style callouts (e.g., <Info>, <Warning>) for clearer rendering.
• Generator verification loop: Runs the documentation generator and then validates formatting and build output via analysis and Jaspr build/serve.

Quick Start

Use the skill to review the generated markdown under docs/content/packages/, audit missing or weak Dart doc comments, regenerate the docs with dart scripts/generate_docs.dart, and confirm the result by running dart analyze docs and jaspr serve.