phoenix-typescript-package-docs
Installation
SKILL.md
Phoenix TypeScript Package Docs
Keep the curated TypeScript package docs aligned with the real npm package surface area and with the publish-time sync flow.
Quick Reference
| Task | What to inspect | What to update |
|---|---|---|
| Fix a stale example | js/packages/<pkg>/src/ exports and function signatures |
Canonical MDX under docs/phoenix/sdk-api-reference/typescript/packages/<pkg>/ |
| Add or remove a page | Existing package-doc folder and docs.json nav |
Canonical MDX, docs.json, and any landing-page links |
| Add a new package to the bundled-docs system | js/scripts/sync-package-docs.mjs and package package.json |
Sync map, package files, package prepack, and Mintlify nav |
| Verify publish output | node js/scripts/sync-package-docs.mjs and npm pack --dry-run |
Generated js/packages/<pkg>/docs/ contents and tarball entries |
Source Of Truth
The canonical authored docs live in Mintlify pages: