api-doc

name	api-doc
description	Write and format API reference documentation. Use when creating or editing API docs in docs/src/pages/docs/api/, formatting method signatures, parameter tables, or ensuring consistent header hierarchy.

API Documentation Skill

Required Context

Read these files before writing API docs:

1. ai/documentation/api/api-authoring.md - Formatting rules and header hierarchy
2. ai/documentation/shared/slop-identification.md - Quality standards
3. ai/documentation/shared/good-examples.md - Style reference
4. ai/documentation/shared/link-grammar.md - Cross-referencing

Canonical Reference Docs

Read 1-2 of these to understand the correct format:

• docs/src/pages/docs/api/utils/strings.mdx - Correct H3/H4 hierarchy, options tables
• docs/src/pages/docs/api/query/dimensions.mdx - Cleaned up format with groupings
• docs/src/pages/docs/api/query/position.mdx - Simple methods with PlaygroundExamples