skills.rest
ag-grid
ag-gridOFFICIAL
Explore all skills by this author →
WebsiteGitHub

Spruce Docs

Generate AG Charts documentation pages with validated API references and framework-compatible examples.

477|41|Updated Jun 29, 2023
Search Tags:#documentation#technical writing#content generation#API reference#AG Charts#framework compatibility#docs automation
One-click install
npx skills add https://github.com/ag-grid/ag-charts --skill spruce-docs
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: Spruce Docs
Source: https://github.com/ag-grid/ag-charts/tree/main/tools/prompts/skills/spruce-docs
Command: npx skills add https://github.com/ag-grid/ag-charts --skill spruce-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill streamlines the creation and improvement of AG Charts documentation pages, ensuring technical accuracy, consistent patterns, and full framework compatibility. It automates the research, structuring, and validation steps, drastically reducing the manual effort and potential for errors in technical writing.

Core Features & Use Cases

  • Structured Documentation Workflow: Guides through a comprehensive process from API research and planning to content creation and mandatory validation.
  • Technical Accuracy Validation: Ensures all documented properties, types, and default values precisely match the TypeScript definitions and implementation.
  • Framework-Compatible Examples: Guarantees that all code examples work seamlessly across vanilla JavaScript, React, Angular, and Vue, critical for a multi-framework library.
  • Use Case: When a new chart feature is developed, use this Skill to automatically generate its documentation page, complete with accurate API references and fully functional, framework-compatible examples, ready for publication.

Quick Start

Create a new documentation page for the 'waterfall' series, including all necessary API details and framework-compatible examples.