This is what an AI/RAG pipeline sees when it indexes this page — the same output served at https://camelmind-docs.vercel.app/api/llms/features/feedback-widget.Back to doc

Rendered doc

Feedback widget

Collect content feedback from readers and route submissions to your team's notification service.

The Feedback widget lets readers tell you whether a content page was helpful. Readers can rate the page, select a reason for negative feedback, and optionally leave additional comments.

Each submission goes to a single API endpoint, which makes integrating with Slack, Microsoft Teams, email, Jira, or your own internal notification system easy.

Enable the Feedback widget

Enable the widget in camelmind.config.ts:

ts
site: {
  showFeedbackWidget: true,
},

When enabled, the widget appears at the bottom of every documentation page.

What readers see

Readers can:

  • Mark a page as Helpful or Not helpful
  • Select a reason when leaving negative feedback
  • Leave an optional comment
  • Specify whether they would like a follow-up on their feedback

Each submission automatically includes the page title and URL.

Route feedback to your notification service

CamelMind routes all feedback to:

text
app/api/feedback/route.ts

Update this route to forward submissions to your preferred notification service. CamelMind includes a Slack implementation by default, but you can customize the route to integrate with any service, including:

  • Slack
  • Microsoft Teams
  • Discord
  • Email
  • Jira
  • Linear
  • GitHub Issues
  • Custom internal APIs

Once you've configured your notification service, update app/api/feedback/route.ts to send the feedback payload to your destination.

Because every submission passes through this single endpoint, you can also send feedback to multiple destinations—for example, posting to Slack while simultaneously creating a Jira issue.

Feedback payload

Each submission includes the following information.

FieldDescription
ratingIndicates whether the reader marked the page as helpful or not helpful.
reasonThe selected reason and any optional comment.
allowFollowUpWhether the reader agreed to a follow-up.
pageTitleThe title of the documentation page.
pageSlugThe URL path of the documentation page.

You can use these values in app/api/feedback/route.ts to format messages or populate tickets in your notification system.

Example: Customize the notification

The default implementation posts feedback to Slack. To use another service, replace the notification logic in app/api/feedback/route.ts while keeping the request handling and feedback payload unchanged.

For example, you can:

  • Send an email using Resend, SendGrid, or Postmark.
  • Create an issue in Jira or GitHub.
  • Post a message to Microsoft Teams or Discord.
  • Forward the payload to an internal API for further processing.

You do not depend on any specific notification provider—the API route gives you complete control over feedback delivery.

What the AI sees

1> For a complete documentation index, see /llms.txt. To read any public page as Markdown, append .md to the URL.
2 
3The Feedback widget lets readers tell you whether a content page was helpful. Readers can rate the page, select a reason for negative feedback, and optionally leave additional comments.
4 
5Each submission goes to a single API endpoint, which makes integrating with Slack, Microsoft Teams, email, Jira, or your own internal notification system easy.
6 
7---
8 
9## Enable the Feedback widget
10 
11Enable the widget in `camelmind.config.ts`:
12 
13```ts
14site: {
15 showFeedbackWidget: true,
16},
17```
18 
19When enabled, the widget appears at the bottom of every documentation page.
20 
21---
22 
23## What readers see
24 
25Readers can:
26 
27- Mark a page as **Helpful** or **Not helpful**
28- Select a reason when leaving negative feedback
29- Leave an optional comment
30- Specify whether they would like a follow-up on their feedback
31 
32Each submission automatically includes the page title and URL.
33 
34---
35 
36## Route feedback to your notification service
37 
38CamelMind routes all feedback to:
39 
40```text
41app/api/feedback/route.ts
42```
43 
44Update this route to forward submissions to your preferred notification service. CamelMind includes a Slack implementation by default, but you can customize the route to integrate with any service, including:
45 
46- Slack
47- Microsoft Teams
48- Discord
49- Email
50- Jira
51- Linear
52- GitHub Issues
53- Custom internal APIs
54 
55Once you've configured your notification service, update `app/api/feedback/route.ts` to send the feedback payload to your destination.
56 
57Because every submission passes through this single endpoint, you can also send feedback to multiple destinations—for example, posting to Slack while simultaneously creating a Jira issue.
58 
59---
60 
61## Feedback payload
62 
63Each submission includes the following information.
64 
65| Field | Description |
66|------|-------------|
67| `rating` | Indicates whether the reader marked the page as helpful or not helpful.|
68| `reason` | The selected reason and any optional comment. |
69| `allowFollowUp` | Whether the reader agreed to a follow-up. |
70| `pageTitle` | The title of the documentation page. |
71| `pageSlug` | The URL path of the documentation page. |
72 
73You can use these values in `app/api/feedback/route.ts` to format messages or populate tickets in your notification system.
74 
75---
76 
77## Example: Customize the notification
78 
79The default implementation posts feedback to Slack. To use another service, replace the notification logic in `app/api/feedback/route.ts` while keeping the request handling and feedback payload unchanged.
80 
81For example, you can:
82 
83- Send an email using Resend, SendGrid, or Postmark.
84- Create an issue in Jira or GitHub.
85- Post a message to Microsoft Teams or Discord.
86- Forward the payload to an internal API for further processing.
87 
88You do not depend on any specific notification provider—the API route gives you complete control over feedback delivery.

Issues (0)

No AI-friendliness issues found.