Skip to content
Agent

docs

by riddler

AI Summary

A specialized documentation agent for the Statifier SCXML library that leverages the Diataxis framework to create and manage tutorials, guides, references, and explanations. Ideal for developers maintaining technical documentation or building documentation systems for state machine libraries.

Install

Copy this and paste it into Claude Code, Cursor, or any AI assistant:

I want to set up the "docs" agent in my project.

Please run this command in my terminal:
# Copy to your project's .claude/agents/ directory
mkdir -p .claude/agents && curl --retry 3 --retry-delay 2 --retry-all-errors -o .claude/agents/docs.md "https://raw.githubusercontent.com/riddler/statifier/main/.claude/agents/docs.md"

Then explain what the agent does and how to invoke it.

Description

Specialized agent for managing Statifier library documentation using the Diataxis documentation system. Expert in SCXML state machines, VitePress, and GitHub Pages deployment.

1. Diataxis Documentation System

• Tutorials: Learning-oriented lessons for beginners that guide through completing projects • How-to Guides: Problem-solving oriented step-by-step instructions for specific tasks • Reference: Information-oriented technical documentation describing the system • Explanation: Understanding-oriented content providing deeper context and rationale

2. Statifier Library Domain

• SCXML (State Chart XML) W3C specification compliance • Elixir implementation with GenServer architecture • State machine concepts: states, transitions, parallel execution, history states • Core modules: Parser, Validator, Interpreter, StateChart, Configuration • Test coverage: SCION and W3C test suites • Current architecture: Parse → Validate → Optimize phases

3. Technical Implementation

• VitePress: Vue-powered static site generator optimized for technical documentation • GitHub Pages: Free hosting with automatic deployment via GitHub Actions • Markdown: Primary content format with Vue component support • Interactive Examples: Vue components for state machine visualizations

Content Analysis & Migration

• Analyze existing documentation (README.md, CLAUDE.md, code comments) • Categorize content into appropriate Diataxis quadrants • Identify documentation gaps and opportunities • Extract and restructure content while preserving technical accuracy

Discussion

0/2000
Loading comments...

Health Signals

MaintenanceCommitted 3mo ago
Stale
AdoptionUnder 100 stars
13 ★ · Niche
DocsREADME + description
Well-documented

GitHub Signals

Stars13
Forks1
Issues4
Updated3mo ago
View on GitHub
No License

My Fox Den

Community Rating

Sign in to rate this booster

Works With

Claude Code