Skip to content

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

Sushmithamallesh4dffd4899089
diff --git a/.github/workflows/claude-code-doc-review.yml b/.github/workflows/claude-code-doc-review.yml
index 4cd5fffe0..eb5dd131c 100644
--- a/.github/workflows/claude-code-doc-review.yml
+++ b/.github/workflows/claude-code-doc-review.yml
@@ -3,9 +3,12 @@ name: Claude Docs Review
on:
pull_request:
types: [ opened, synchronize ]
- # Run on docs changes (new Fumadocs system)
+ # Run on docs changes (content, components, styles)
paths:
- "docs/content/**/*.mdx"
+ - "docs/components/**/*.tsx"
+ - "docs/app/**/*.tsx"
+ - "docs/app/**/*.css"
jobs:
claude-review:
# Optional: Filter by PR author
@@ -47,8 +50,10 @@ jobs:
## Documentation Structure
- - Content lives in `docs/content/**/*.mdx`
- - Design tokens in `docs/app/global.css` (use `--composio-orange`, `--composio-sidebar`)
+ - Content: `docs/content/**/*.mdx`
+ - Components: `docs/components/**/*.tsx`
+ - App routes: `docs/app/**/*.tsx`
+ - Design tokens: `docs/app/global.css` (use `--composio-orange`, `--composio-sidebar`)
- MDX components available globally: `Tabs`, `Callout`, `Steps`, `Cards`, `Accordion`, etc.
## Critical Technical Rules
@@ -72,9 +77,45 @@ jobs:
- Code examples: Use `<Tabs>` for multi-language snippets
- No emojis in changelog entries
+ ## Component Review (for .tsx files)
+
+ When reviewing component files, verify:
+ - Component renders correctly (no runtime errors)
+ - Props are properly typed
+ - Accessibility: proper aria labels, semantic HTML, keyboard navigation
+ - Responsive design: works on mobile and desktop
+ - No hardcoded strings that should be props
+ - Consistent with existing component patterns in `docs/components/`
+
+ ## MDX Rendering Quality
+
+ - Frontmatter is valid YAML with required fields (`title`, `description`)
+ - MDX components are properly closed and nested
+ - Code blocks have correct language identifiers
+ - Links are valid (no broken internal links)
+ - Images have alt text
+ - Tables render correctly (proper markdown table syntax)
+
+ ## SEO Requirements
+
+ Every MDX page MUST have proper SEO:
+ - **title**: Concise, descriptive (50-60 chars ideal)
+ - **description**: Compelling summary for search results (150-160 chars ideal)
+ - **Headings**: One H1 only (from title), logical H2/H3 hierarchy
+ - **Internal links**: Link to related docs where relevant
+ - **URL structure**: Clean, descriptive slugs (from file path)
+
+ For toolkit/integration pages:
+ - Include the toolkit name in title and description
+ - Describe what users can do with the integration
+ - Link to authentication and usage sections
+
## Review Focus
- **Code validity**: Will TypeScript examples compile?
+ - **Component quality**: Are components accessible and responsive?
+ - **MDX rendering**: Will the markdown render correctly?
+ - **SEO**: Does the page have good title, description, and heading structure?
- **Clarity**: Is the content clear and scannable?
- **Accuracy**: Are technical details correct?
- **Consistency**: Does tone match existing docs?