@devries-cameron20 / composio-1 / commits / 38a44abb3
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.

docs(CLAUDE): document relative-paths rule for internal links

Anshu Garg committed Apr 21, 2026 at 01:58 UTC 38a44abb383b74b1bdb0016f164c0a11289713d5
1 file changed +2
docs/CLAUDE.md
+2
@@ -77,6 +77,8 @@ Detailed documentation for Claude is organized in `.claude/`:
77 - Dynamic toolkit pages are validated against slugs from `public/data/toolkits.json`
78 - Non-Fumadocs `.md` files (like FAQ snippets) are picked up via `content/**/*.md` glob
79
80 +10. **Internal links use relative paths, never absolute** - Write `/docs/<section>/<page>`, `/reference/api-reference/<resource>/<operationId>`, `/reference/sdk-reference/<lang>/<page>`, `/docs/changelog/YYYY/MM/DD`, `/assets/images/<file>`. Never `https://docs.composio.dev/...`. The link checker (rule 9) only validates relative links; absolute URLs silently bypass it and rot over time. API-reference operation IDs are **camelCase** (`getConnectedAccountsByNanoid`, `postAuthConfigs`) — do not guess them; copy the exact `href` from `<ApiEndpointsTable>` in `content/reference/api-reference/<resource>/index.mdx`. Previous changelog entries use zero-padded month/day (`/docs/changelog/2026/04/21`, not `2026/4/21`).
81 +
82 ## Glossary
83
84 `content/docs/glossary.mdx` defines key Composio terms (auth config, session, toolkit, etc.) using `<Glossary>` and `<GlossaryTerm name="...">` components (`components/glossary.tsx`). The component renders a filterable two-column table. The markdown converter in `lib/source.ts` converts `<GlossaryTerm>` tags to `### Term` headings for LLM-friendly output. When adding new Composio concepts, add a `<GlossaryTerm>` entry and update the `keywords` frontmatter array.