cs-libdoc

Generates per-entry API reference documentation from source code with manifest tracking.

Updated Jun 8, 2026
One-click install
npx skills add https://github.com/wildlily1021/XW_Software --skill cs-libdoc-wildlily1021
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: cs-libdoc
Source: https://github.com/wildlily1021/XW_Software/tree/main/.agents/skills/cs-libdoc
Command: npx skills add https://github.com/wildlily1021/XW_Software --skill cs-libdoc-wildlily1021

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve? Writing accurate API reference documentation for a library's public surface is tedious and error-prone, especially when entries are copied from each other or written without reading the source. This Skill generates reference docs entry-by-entry directly from source code, with a manifest to track coverage and staleness. ## Core Features & Use Cases - Manifest-driven tracking: Scans the source tree, builds a manifest.yaml listing every public entry (component, function, endpoint, command) with status (pending/draft/current/outdated/skipped). - Single and batch generation modes: Produce one entry at a time for review, or batch-generate dozens of entries after confirming 2-3 sample docs with the user. - Incremental updates: Detects outdated entries after code changes and refreshes only what changed, keeping docs synchronized with the source. - Use Case: After shipping a Vue component library, run this Skill to scan src/components, generate a manifest of all public components, and produce one accurate reference doc per component with props, defaults, and events extracted from the actual code. ## Quick Start Ask the AI to generate API reference documentation for all public components in the library, starting with a manifest of entries.

Frequently Asked Questions about cs-libdoc

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

FAQPage Schema
How do I generate API reference documentation from source code?▼

Scan the source root to identify public exports, group them into entries, and record them in a manifest.yaml. Then generate one doc per entry by reading its source files to extract signatures, types, defaults, and comments rather than guessing.

What is the difference between reference docs and tutorial docs?▼

Reference docs describe each public entry's exact surface (props, parameters, defaults) with source code as the fact source. Tutorials are task-oriented guides explaining how to accomplish a goal. This Skill produces reference docs, complementing guide-style documentation.

How do I keep API docs in sync after code changes?▼

Use the incremental update phase: find entries marked outdated, compare manifest last_scanned against changed source files, or sort by last_reviewed. Re-read the source, update only the changed sections, and set status back to current.

Can I batch-generate documentation for many components at once?▼

Yes, batch mode generates all pending entries, but you must first produce 2-3 sample entries from different categories and get user confirmation on style and detail level. Each entry still requires independently reading its own source files.

What happens when source code uses dynamic exports or code generation?▼

Entries whose source structure cannot be reliably read, such as dynamic exports or generated code, should be marked skipped in the manifest with an explanatory note. Fabricating documentation for unreadable interfaces is treated as worse than no documentation.