SKILL.md

Petit ships with a agentic skill called petit-writer that teaches agents how to write documentation using Petit's components, configuration, and conventions. When installed, the agent knows how to set up Petit from scratch, write pages with the correct frontmatter, use components like tabs, steps, and cards, and configure petit.config.json properly.

What it does

The skill gives agents three reference files:

• Writing standards - voice, tone, formatting rules, and a verification checklist
• Petit reference - the full config schema, every CLI command, all components with syntax, themes, media handling, and SEO
• Setup guide - a playbook for creating documentation from zero, including information architecture and page classification

When you invoke the skill, the agent reads the relevant references and applies them to your request. It can write new pages, edit existing docs, configure your project, or set up Petit in a new repo.

Install

The skill files live in the skills/petit-writer/ directory of the Petit repository. Copy them into your project's .agents/skills/ or .claude/skills directory:

To install the skill globally (available in all your projects), copy it to ~/.agents/skills/petit-writer/ or ~/.claude/skills/petit-writer/ instead.

Usage

Invoke the skill directly with a slash command:

/petit-writer

You can also pass arguments to describe what you want:

/petit-writer "add a deployment guide for Railway"
/petit-writer "update the API reference for the new auth module"
/petit-writer "set up Petit docs from scratch for this project"

Agents could also invokes the skill automatically when you ask it to write or edit documentation in a project that has Petit configured, based on your hook setups.

Examples

Here are common tasks the skill handles:

• New docs from scratch - "Set up documentation for this project using Petit. It's a CLI tool written in Rust."
• Write a page - "Write a getting started guide that covers installation and the first three commands."
• Edit existing docs - "The auth module changed. Update the reference page to match the new API."
• Configure Petit - "Add a dark theme, enable SEO, and set up the sidebar for three categories."
• Use components - "Add install tabs for the package and a steps component for the setup flow."

Customization

The skill files are plain markdown. You can modify them to fit your project's conventions:

• Edit documentation.md to adjust voice, tone, or formatting rules for your team
• Edit petit.md if you add custom components or use a specific subset of Petit features
• Edit setup.md to match your project's category structure or content priorities

Restart your agent and try your changes.