@devries-cameron20 / composio Mirror · read-only / commits / 7026f5814
Fork 0

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, 08:15 UTC

docs: add link checker and FAQ nuances to CLAUDE.md

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Sushmithamallesh committed Feb 18, 2026 at 11:49 UTC 7026f5814ab82cfbd882a46c6101f240111cb136
1 file changed +12 -2
docs/CLAUDE.md
+12 -2
@@ -20,10 +20,12 @@ docs/
20 │ ├── docs/ # Main documentation
21 │ ├── cookbooks/ # Cookbooks & guides
22 │ ├── changelog/ # Release notes
23 -│ └── reference/ # SDK & API reference
23 +│ ├── reference/ # SDK & API reference
24 +│ └── toolkits/ # Toolkit docs + faq/ snippets
25 ├── components/ # React components
26 ├── lib/ # Utilities
27 ├── public/ # Static assets
28 +├── scripts/ # Build scripts (link checker, etc.)
29 └── .claude/ # Claude context (see below)
30 ```
31
@@ -50,7 +52,7 @@ Detailed documentation for Claude is organized in `.claude/`:
52
53 1. **TypeScript code blocks are type-checked** - All TS code in MDX is validated at build time. See [twoslash.md](.claude/context/twoslash.md).
54
53 -2. **Run build before pushing** - `bun run build` catches type errors that `bun dev` misses.
55 +2. **Run build before pushing** - `bun run build` catches type errors that `bun dev` misses. Also run `bun run scripts/validate-links.ts` to catch broken internal links.
56
57 3. **CSS variables** - Use `var(--composio-orange)` not `var(--orange)`. Check `app/global.css`.
58
@@ -60,6 +62,14 @@ Detailed documentation for Claude is organized in `.claude/`:
62
63 6. **Test on mobile** - Fumadocs nav differs on mobile. Avoid assumptions about horizontal layout.
64
65 +7. **Toolkit FAQ files** - FAQ snippets live in `content/toolkits/faq/{slug}.md`. They're plain markdown (no frontmatter) embedded in toolkit pages at build time, not standalone Fumadocs pages. They're excluded from the toolkits Fumadocs source via `files: ['**/*', '!faq/**']` in `source.config.ts` but still scanned by the link checker.
66 +
67 +8. **Link checker** - `scripts/validate-links.ts` validates all internal links. It needs `bunfig.toml` (Bun preload for fumadocs-mdx) to run. Key details:
68 + - Populate keys use `(home)/` prefix to match the `app/(home)/` route group
69 + - Fragment validation falls back to parsing raw markdown headings (since `data.toc` is unavailable outside Next.js)
70 + - Dynamic toolkit pages are validated against slugs from `public/data/toolkits.json`
71 + - Non-Fumadocs `.md` files (like FAQ snippets) are picked up via `content/**/*.md` glob
72 +
73 ## AI-Native Documentation
74
75 **Prefer cURL over "click"** - Most docs traffic comes from AI crawlers. When documenting API interactions, prefer showing cURL commands over UI instructions like "click this button" or "navigate to settings". cURL is machine-readable and can be directly executed by AI agents.