Write, update, and format docs for public APIs - API reference, README, docstrings, usage examples, migration guides, deprecation notices
npxskills add reactive/data-client--skill packages-documentationLoading…
This guide covers how to write and format documentation for public library interfaces.
The /docs folder is organized by package:
docs/core/ - Documentation for @data-client/core and @data-client/reactdocs/rest/ - Documentation for @data-client/restdocs/graphql/ - Documentation for @data-client/graphqlEach package documentation has subdirectories:
api/ - API reference documentation (one file per public class/function/hook)guides/ - How-to guides and tutorialsconcepts/ - Conceptual documentationgetting-started/ - Getting started guidesAPI documentation files should match the exported name:
useSuspense.ts → docs/core/api/useSuspense.mdRestEndpoint.js → docs/rest/api/RestEndpoint.mdController.ts → docs/core/api/Controller.mdEntity.ts → docs/rest/api/Entity.md (or docs/core/api/Entity.md)All API documentation files should include:
---
title: API Name
sidebar_label: Display Name
---
Description - What the API does
Usage examples - Code examples showing how to use it
Parameters/Options - Document all parameters, options, and return types
Type information - TypeScript types and examples
Related APIs - Links to related documentation
packages/core, packages/rest, etc.)index.ts or main entry point to see what's exporteddocs/{package}/api/docs/{package}/guides/packages/react/src/hooks/useNewFeature.tsdocs/core/api/useNewFeature.md with usage examples and API referencepackages/rest/src/RestEndpoint.js (changing extend() method)docs/rest/api/RestEndpoint.md with new signature, migration notes, and updated examplespackages/core/src/SomeClass.ts (deprecating oldMethod())docs/core/api/SomeClass.md with deprecation noticepackages/rest/src/RestEndpoint.js (adding newOption parameter)docs/rest/api/RestEndpoint.md to document the new option with examplesBefore completing changes to public APIs in /packages:
/docs/{package}/api/index.ts or src/index.ts)_, not exported, or marked as @internal) don't require documentation updates
Create or update AgentSkills. Use when designing, structuring, or packaging skills with scripts, references, and assets.
Create or update AgentSkills. Use when designing, structuring, or packaging skills with scripts, references, and assets.
Set up and use 1Password CLI (op). Use when installing the CLI, enabling desktop app integration, signing in (single or multi-account), or reading/injecting/running secrets via op.
CLI to manage emails via IMAP/SMTP. Use `himalaya` to list, read, write, reply, forward, search, and organize emails from the terminal. Supports multiple accounts and message composition with MML (MIME Meta Language).
Create or update AgentSkills. Use when designing, structuring, or packaging skills with scripts, references, and assets.
Create or update AgentSkills. Use when designing, structuring, or packaging skills with scripts, references, and assets.
Set up and use 1Password CLI (op). Use when installing the CLI, enabling desktop app integration, signing in (single or multi-account), or reading/injecting/running secrets via op.
CLI to manage emails via IMAP/SMTP. Use `himalaya` to list, read, write, reply, forward, search, and organize emails from the terminal. Supports multiple accounts and message composition with MML (MIME Meta Language).