Composio powers 1000+ toolkits, tool search, context management, authentication, and a sandboxed workbench to help you build AI agents that turn intent into action.

next
md 25 lines 759 Bytes
Rendered Raw
1 # SDK Documentation Generator
2
3 Generates MDX reference docs from TypeScript source using TypeDoc.
4
5 ## Usage
6
7 ```bash
8 pnpm generate:docs
9 ```
10
11 ## How it works
12
13 1. TypeDoc extracts JSDoc from `src/models/*.ts` → JSON AST
14 2. `generate-docs.ts` transforms AST → MDX files
15 3. Output written to `docs/content/reference/sdk-reference/typescript/`
16
17 ## Configuration
18
19 - **Entry points**: Auto-discovered from `src/models/*.ts`
20 - **Excluded classes**: `INTERNAL_CLASSES` set in script
21 - **User-instantiated classes**: `USER_INSTANTIATED_CLASSES` (shows constructor)
22
23 ## CI
24
25 `.github/workflows/docs-sdk-reference-drift.yml` regenerates the reference on PRs to `next` that change `ts/packages/core/src/**` or this generator, and fails if the committed output differs.