api-reference-writer
Flue API Reference Writer
Create concise, lookup-oriented Flue reference documentation from the supported public TypeScript interface. Treat source-adjacent JSDoc as the canonical home for public reference material and Markdown pages as a faithful editorial projection of that material.
This skill covers the initial documentation pass. Do not design a generator, manifest, CI check, or automated maintenance workflow unless the user explicitly asks for one.
Desired result
Reference pages should resemble Vite's configuration reference: a lightly organized list of documented exports, interfaces, methods, properties, or options. Keep narrative close to zero.
A reference page should help readers answer:
- What can I import or configure?
- What is the TypeScript signature or field type?
- What does it do?
- What is the default, when one exists?
- What constraints, lifecycle semantics, or deprecations matter when using it?
Move broad concepts, end-to-end procedures, deployment setup, and extended examples into guides rather than preserving them in reference pages.