Composio powers 1000+ toolkits, tool search, context management, authentication, and a sandboxed workbench to help you build AI agents that turn intent into action.
Mirrored from https://github.com/Camo67/composio.git
Synced Nov 22, 15:45 UTC
Add SDK reference documentation for contributors
- Add SDK Reference Docs section to fumadocs/CLAUDE.md - Add README.md for the generate-docs.ts script 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Sushmithamallesh committed
Jan 6, 2026 at 15:19 UTC
85625c38a755a86315b764936ba78b67b4646a98
2 files changed
+35
fumadocs/CLAUDE.md
+10
@@ -16,6 +16,16 @@ This is the Composio documentation site built with Fumadocs (Next.js-based docs
16
- `--font-sans: 'Inter'` - Body text
17
- `--font-mono: 'IBM Plex Mono'` - Code blocks
18
19
+## SDK Reference Docs
20
+Auto-generated TypeScript SDK documentation from `@composio/core` source code.
21
+
22
+- **Source**: `ts/packages/core/src/models/*.ts` (JSDoc comments)
23
+- **Generator**: `ts/packages/core/scripts/generate-docs.ts`
24
+- **Output**: `content/reference/sdk-reference/typescript/`
25
+- **Regenerate**: `pnpm --filter @composio/core generate:docs`
26
+
27
+CI auto-generates on changes to `ts/packages/core/src/**` via `.github/workflows/generate-sdk-docs.yml`.
28
+
29
## Common Gotchas
30
1. **CSS variables**: Use `var(--composio-orange)` not `var(--orange)`. Check `global.css` for defined variables.
31
2. **Date format**: Changelog dates must be YYYY-MM-DD format (validated in schema and runtime)
ts/packages/core/scripts/README.md
new
+25
@@ -0,0 +1,25 @@
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 `fumadocs/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/generate-sdk-docs.yml` triggers on changes to `ts/packages/core/src/**` and opens a PR with updated docs.