pikku-api-doc

Name: pikku-api-doc
Availability: InStock
Author: Pikku

Generate Pikku API reference pages from TypeScript sources.

1|Updated Jul 15, 2021

Search Tags:#typescript #documentation #docs #generate #api-docs #pikku

Ready to run

npx skills add https://github.com/pikkujs/website --skill pikku-api-doc

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: pikku-api-doc
Source: https://github.com/pikkujs/website/tree/main/.claude/skills/pikku-api-doc
Command: npx skills add https://github.com/pikkujs/website --skill pikku-api-doc

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill reads TypeScript source and generates or updates API reference documentation for a Pikku service, interface, or class, helping teams keep API docs in sync with code.

Core Features & Use Cases

Automated API documentation generation: Generates complete API reference pages from source files.
Supports Pikku services, interfaces, and classes: Works across Pikku's codebase to document APIs.
Use Case: When you add or modify a service interface, run this skill to generate or update the API docs accordingly.

Quick Start

Generate or update the API reference page for a Pikku service by scanning its TypeScript source and outputting a Pikku doc page.

Frequently Asked Questions about pikku-api-doc

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

FAQPage Schema

How do I auto-generate API documentation from TypeScript source files?▼

To auto-generate API documentation from TypeScript source files, use this skill to scan Pikku services, interfaces, and classes, producing a complete reference page listing methods, parameters, returns, and examples.

What is the best way to keep Pikku API docs in sync with code?▼

Keeping Pikku API docs in sync with code involves reading the TypeScript source of modified services or interfaces and regenerating the API reference page to reflect the updated methods, parameters, and returns.

Can I generate API docs for TypeScript classes and interfaces across a monorepo?▼

Yes, you can generate API docs for TypeScript classes and interfaces across a monorepo by applying the skill across pikku/packages to identify the API surface and output a consistent documentation structure.

Does the generated API documentation include methods, parameters, and examples?▼

Yes, the generated API documentation includes methods, parameters, returns, and examples. It formats these elements into a consistent Pikku doc page that fully outlines the identified API surface.

How to update an existing API reference page after modifying a Pikku service?▼

To update an existing API reference page after modifying a Pikku service, run the skill against the updated TypeScript source to regenerate the documentation, ensuring the output matches the current codebase structure.