What problem does it solve?
Public TypeScript APIs in Expo SDK packages need consistent, high-quality TSDoc comments so the docs generation pipeline (GenerateDocsAPIData + TypeDoc) can produce accurate API reference pages. Without conventions, developers write inconsistent or useless docblocks that degrade the generated documentation.
Core Features & Use Cases
- TSDoc conventions: Enforces third-person declarative style, correct use of @param, @return, @default, @platform, @example, @deprecated, and other supported tags.
- Docs generation compatibility: Covers type export patterns from entry points so GenerateDocsAPIData picks up all public symbols.
- MDX usage examples: Provides formats for code blocks, SnackInline interactive examples, Collapsible sections, and APISection references in documentation pages.
- Use Case: When adding a new function like getUptimeAsync to an expo-* package, use this Skill to write the docblock with platform annotations, a code example, and proper return-value language from the start.
Quick Start
Write TSDoc comments for the new public API I just added to my expo-* package following the Expo documentation conventions.