@devries-cameron20 / composio-1 / commits / 4dffd4899
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: expand review scope to components, MDX quality, and SEO

- Trigger on component files (.tsx) and CSS changes - Add component review criteria (accessibility, responsive, typed props) - Add MDX rendering quality checks (frontmatter, links, tables) - Add SEO requirements (title/description length, heading hierarchy) - Special guidance for toolkit/integration pages

Sushmithamallesh committed Jan 28, 2026 at 14:01 UTC 4dffd4899089d42468abce60c3805adf1e1e4c73
1 file changed +44 -3
.github/workflows/claude-code-doc-review.yml
+44 -3
@@ -3,9 +3,12 @@ name: Claude Docs Review
3 on:
4 pull_request:
5 types: [ opened, synchronize ]
6 - # Run on docs changes (new Fumadocs system)
6 + # Run on docs changes (content, components, styles)
7 paths:
8 - "docs/content/**/*.mdx"
9 + - "docs/components/**/*.tsx"
10 + - "docs/app/**/*.tsx"
11 + - "docs/app/**/*.css"
12 jobs:
13 claude-review:
14 # Optional: Filter by PR author
@@ -47,8 +50,10 @@ jobs:
50
51 ## Documentation Structure
52
50 - - Content lives in `docs/content/**/*.mdx`
51 - - Design tokens in `docs/app/global.css` (use `--composio-orange`, `--composio-sidebar`)
53 + - Content: `docs/content/**/*.mdx`
54 + - Components: `docs/components/**/*.tsx`
55 + - App routes: `docs/app/**/*.tsx`
56 + - Design tokens: `docs/app/global.css` (use `--composio-orange`, `--composio-sidebar`)
57 - MDX components available globally: `Tabs`, `Callout`, `Steps`, `Cards`, `Accordion`, etc.
58
59 ## Critical Technical Rules
@@ -72,9 +77,45 @@ jobs:
77 - Code examples: Use `<Tabs>` for multi-language snippets
78 - No emojis in changelog entries
79
80 + ## Component Review (for .tsx files)
81 +
82 + When reviewing component files, verify:
83 + - Component renders correctly (no runtime errors)
84 + - Props are properly typed
85 + - Accessibility: proper aria labels, semantic HTML, keyboard navigation
86 + - Responsive design: works on mobile and desktop
87 + - No hardcoded strings that should be props
88 + - Consistent with existing component patterns in `docs/components/`
89 +
90 + ## MDX Rendering Quality
91 +
92 + - Frontmatter is valid YAML with required fields (`title`, `description`)
93 + - MDX components are properly closed and nested
94 + - Code blocks have correct language identifiers
95 + - Links are valid (no broken internal links)
96 + - Images have alt text
97 + - Tables render correctly (proper markdown table syntax)
98 +
99 + ## SEO Requirements
100 +
101 + Every MDX page MUST have proper SEO:
102 + - **title**: Concise, descriptive (50-60 chars ideal)
103 + - **description**: Compelling summary for search results (150-160 chars ideal)
104 + - **Headings**: One H1 only (from title), logical H2/H3 hierarchy
105 + - **Internal links**: Link to related docs where relevant
106 + - **URL structure**: Clean, descriptive slugs (from file path)
107 +
108 + For toolkit/integration pages:
109 + - Include the toolkit name in title and description
110 + - Describe what users can do with the integration
111 + - Link to authentication and usage sections
112 +
113 ## Review Focus
114
115 - **Code validity**: Will TypeScript examples compile?
116 + - **Component quality**: Are components accessible and responsive?
117 + - **MDX rendering**: Will the markdown render correctly?
118 + - **SEO**: Does the page have good title, description, and heading structure?
119 - **Clarity**: Is the content clear and scannable?
120 - **Accuracy**: Are technical details correct?
121 - **Consistency**: Does tone match existing docs?