@devries-cameron20 / composio-1 / commits / a3fb5ff90
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: improve Claude review bot guidelines for Fumadocs

- Add documentation structure context (content paths, design tokens) - Include critical technical rules (Twoslash, CSS variables, changelog format) - Specify MDX component usage patterns - Define clear review focus areas - Reference docs/CLAUDE.md and docs/.claude/ for complete guidelines

Sushmithamallesh committed Jan 28, 2026 at 13:59 UTC a3fb5ff9097f08cc6017db5f87d5f3383cfa9e64
1 file changed +38 -6
.github/workflows/claude-code-doc-review.yml
+38 -6
@@ -42,13 +42,45 @@ jobs:
42 REPO: ${{ github.repository }}
43 PR NUMBER: ${{ github.event.pull_request.number }}
44
45 - Please review this pull request for documentation changes and provide feedback on:
46 - - Grammar and spelling
47 - - Clarity and readability
48 - - Consistency and tone
49 - - Proper adherence to the documentation style guide in `docs/CLAUDE.md`
45 + You are reviewing documentation for Composio, built with Fumadocs (https://fumadocs.dev/).
46 + Read `docs/CLAUDE.md` and `docs/.claude/` for complete style guidelines.
47
51 - Be constructive and helpful in your feedback.
48 + ## Documentation Structure
49 +
50 + - Content lives in `docs/content/**/*.mdx`
51 + - Design tokens in `docs/app/global.css` (use `--composio-orange`, `--composio-sidebar`)
52 + - MDX components available globally: `Tabs`, `Callout`, `Steps`, `Cards`, `Accordion`, etc.
53 +
54 + ## Critical Technical Rules
55 +
56 + 1. **TypeScript code blocks are type-checked at build time**
57 + - All TS/TSX code must compile. Invalid code fails the build.
58 + - Use `// ---cut---` to hide setup code (imports, declarations) from output
59 + - Use `// @noErrors` only when necessary for partial snippets
60 + - Prefer SDK-exported types over inline type annotations
61 +
62 + 2. **CSS variables must use full names**
63 + - ✓ `var(--composio-orange)`
64 + - ✗ `var(--orange)`
65 +
66 + 3. **Changelog frontmatter**
67 + - Date format: `YYYY-MM-DD` (e.g., `2025-01-28`)
68 + - Required fields: `title`, `date`
69 +
70 + 4. **MDX components**
71 + - Breaking changes: `<Callout type="warn">` with before/after code
72 + - Code examples: Use `<Tabs>` for multi-language snippets
73 + - No emojis in changelog entries
74 +
75 + ## Review Focus
76 +
77 + - **Code validity**: Will TypeScript examples compile?
78 + - **Clarity**: Is the content clear and scannable?
79 + - **Accuracy**: Are technical details correct?
80 + - **Consistency**: Does tone match existing docs?
81 + - **Mobile**: Avoid CSS that assumes horizontal nav layout
82 +
83 + Be constructive. Suggest specific improvements, not vague feedback.
84 # Optional: Customize review based on file types
85 # direct_prompt: |
86 # Review this PR focusing on: