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 21, 03:37 UTC
| 1 | # Docs Feedback System |
| 2 | |
| 3 | ## Decision |
| 4 | Use Slack webhooks for collecting documentation feedback. |
| 5 | |
| 6 | ## Why Slack? |
| 7 | Considered options: |
| 8 | | Option | Pros | Cons | |
| 9 | |--------|------|------| |
| 10 | | GitHub Issues | Public, trackable, no backend | Requires GitHub account | |
| 11 | | Slack webhook | Instant visibility, team already there, simple | Can get noisy | |
| 12 | | Vercel KV | On same platform | Overkill, need to build UI to view | |
| 13 | | Email (mailto:) | Zero backend | Unstructured, easy to ignore | |
| 14 | | Google Sheets | Easy to analyze | Need API setup | |
| 15 | |
| 16 | **Chose Slack** because: |
| 17 | - Team already monitors Slack |
| 18 | - Instant notifications |
| 19 | - Can discuss feedback in threads |
| 20 | - 2-minute setup (just a webhook URL) |
| 21 | - No database to maintain |
| 22 | |
| 23 | ## Implementation |
| 24 | |
| 25 | ### Components |
| 26 | - `components/feedback.tsx` - Modal UI (Geist-style) |
| 27 | - `components/page-actions.tsx` - Contains feedback button |
| 28 | - `app/api/feedback/route.ts` - API route that posts to Slack |
| 29 | |
| 30 | ### Environment Variables |
| 31 | ``` |
| 32 | SLACK_FEEDBACK_WEBHOOK_URL=https://hooks.slack.com/services/xxx/xxx/xxx |
| 33 | ``` |
| 34 | |
| 35 | ### Slack Message Format |
| 36 | ``` |
| 37 | 😊 New Docs Feedback |
| 38 | Page: /docs/quickstart |
| 39 | Sentiment: positive |
| 40 | Feedback: This page was really helpful! |
| 41 | Email: user@example.com (optional) |
| 42 | ``` |
| 43 | |
| 44 | ## Setup Instructions |
| 45 | |
| 46 | 1. Go to https://api.slack.com/apps → Create New App |
| 47 | 2. "From scratch" → Name it, select workspace |
| 48 | 3. Incoming Webhooks → Toggle ON |
| 49 | 4. Add New Webhook to Workspace → Select channel (e.g., #docs-feedback) |
| 50 | 5. Copy webhook URL |
| 51 | 6. Add to Vercel: Project Settings → Environment Variables |
| 52 | |
| 53 | ## Future Improvements |
| 54 | - Add rate limiting to prevent spam |
| 55 | - Track feedback analytics (sentiment trends, common pages) |
| 56 | - Auto-create GitHub issues for negative feedback |