pikku-guide

Create and update Pikku documentation guides with structured sections and code samples.

1|Updated Jul 15, 2021
One-click install
npx skills add https://github.com/pikkujs/website --skill pikku-guide
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: pikku-guide
Source: https://github.com/pikkujs/website/tree/main/.claude/skills/pikku-guide
Command: npx skills add https://github.com/pikkujs/website --skill pikku-guide

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Enables consistent creation and updating of Pikku documentation guides and tutorials, ensuring alignment with Pikku's documentation templates and style.

Core Features & Use Cases

  • Structured doc writer workflow for Pikku core features, wiring, runtimes, middleware, and advanced topics.
  • Generates Docusaurus-ready Markdown pages with required frontmatter (name and description) and a clean page layout.
  • Supports a Quick Start to produce ready-to-publish content from user input.

Quick Start

Provide a topic you want documented (e.g., "write a guide for X") and I will generate a complete Pikku guide page.

Frequently Asked Questions about pikku-guide

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I write documentation for the Pikku framework?

To write documentation for the Pikku framework, provide a topic and this skill generates a complete guide page. It produces structured Markdown with frontmatter, sections for problems and features, and runnable code samples aligned to Pikku conventions.

What sections should Pikku guides and tutorials include?

Pikku guides should include frontmatter with name and description, followed by structured sections: What problem does it solve?, Core Features & Use Cases, and Quick Start. These sections ensure consistent, practical documentation across core features and advanced topics.

How do I generate Docusaurus-ready Markdown pages with frontmatter for Pikku?

You generate Docusaurus-ready Markdown pages by providing a topic you want documented. The skill outputs clean page layouts with required frontmatter containing name and description, ready to publish in your Docusaurus documentation site.

Can I use this to document Pikku wiring protocols and runtimes?

Yes, you can use this to document Pikku wiring protocols, runtimes, middleware, and core features. The doc writer workflow supports drafting guides across these specific Pikku framework topics with aligned code samples.

What is the best way to structure a quick start guide for Pikku?

The best way to structure a quick start guide for Pikku is to provide a topic you want documented. The skill then generates ready-to-publish content with a Quick Start section containing runnable code samples aligned to Pikku conventions.