[PR #8529] [CLOSED] docs: add feedback #8042

Closed
opened 2026-03-13 13:57:53 -05:00 by GiteaMirror · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/better-auth/better-auth/pull/8529
Author: @0-Sandy
Created: 3/9/2026
Status: Closed

Base: canaryHead: docs/add-feedback


📝 Commits (1)

📊 Changes

8 files changed (+940 additions, -15 deletions)

View changed files

📝 landing/.env.example (+6 -0)
📝 landing/app/docs/[[...slug]]/page.tsx (+3 -0)
landing/components/feedback/client.tsx (+351 -0)
landing/components/feedback/schema.ts (+24 -0)
landing/components/ui/collapsible.tsx (+42 -0)
landing/lib/github.ts (+183 -0)
📝 landing/package.json (+2 -0)
📝 pnpm-lock.yaml (+329 -15)

📄 Description

This PR adds a feedback system to the docs (See Feedback in Fumadocs) so readers can easily leave feedback directly from the documentation pages.

Setup

To enable it:

  1. Create a GitHub App.
  2. Get the App ID and App Private Key.
  3. Add them to your environment variables.

The App Private Key supports using \n for line breaks. This is because Vercel can throw errors with multiline environment variables. (See #53183 in Next.js)

  1. In GitHub Discussions create a category named Docs Feedback .

Images

good bad no response writing feedback

Summary by cubic

Adds a lightweight docs feedback widget so readers can rate a page and leave comments. Submissions are sent to GitHub Discussions via a GitHub App and link back to the discussion.

  • New Features

    • Page-level feedback UI on docs pages (Good/Bad + message), with local storage to prevent duplicate prompts and a “View on GitHub” link.
    • Optional block-level feedback (FeedbackBlock) for MDX sections when using Fumadocs’ remark plugin.
    • Server actions in landing/lib/github.ts create or comment on a discussion under the “Docs Feedback” category.
  • Migration

    • Create a GitHub App and set GITHUB_APP_ID and GITHUB_APP_PRIVATE_KEY (use \n for newlines on Vercel).
    • In GitHub Discussions, create a category named “Docs Feedback”.
    • Ensure the target repo/owner match the constants in landing/lib/github.ts (better-auth/better-auth).

Written for commit 5c69f334cf. Summary will update on new commits.


🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/better-auth/better-auth/pull/8529 **Author:** [@0-Sandy](https://github.com/0-Sandy) **Created:** 3/9/2026 **Status:** ❌ Closed **Base:** `canary` ← **Head:** `docs/add-feedback` --- ### 📝 Commits (1) - [`5c69f33`](https://github.com/better-auth/better-auth/commit/5c69f334cf6c67a66635bcbc2c9ecb6651f84d46) docs: add feedback ### 📊 Changes **8 files changed** (+940 additions, -15 deletions) <details> <summary>View changed files</summary> 📝 `landing/.env.example` (+6 -0) 📝 `landing/app/docs/[[...slug]]/page.tsx` (+3 -0) ➕ `landing/components/feedback/client.tsx` (+351 -0) ➕ `landing/components/feedback/schema.ts` (+24 -0) ➕ `landing/components/ui/collapsible.tsx` (+42 -0) ➕ `landing/lib/github.ts` (+183 -0) 📝 `landing/package.json` (+2 -0) 📝 `pnpm-lock.yaml` (+329 -15) </details> ### 📄 Description This PR adds a feedback system to the docs (See [Feedback in Fumadocs](https://www.fumadocs.dev/docs/integrations/feedback)) so readers can easily leave feedback directly from the documentation pages. ### Setup To enable it: 1. Create a GitHub App. 2. Get the App ID and App Private Key. 3. Add them to your environment variables. > The **App Private Key** supports using `\n` for line breaks. This is because Vercel can throw errors with multiline environment variables. (See [#53183](https://github.com/vercel/next.js/issues/53183) in Next.js) 4. In GitHub Discussions create a category named `Docs Feedback` . ### Images <img width="1901" height="939" alt="good" src="https://github.com/user-attachments/assets/ca45bac7-916c-4b36-8b50-de8637b9df6b" /> <img width="1894" height="939" alt="bad" src="https://github.com/user-attachments/assets/1d950d91-6a52-4139-ab71-9321726898e0" /> <img width="1898" height="926" alt="no response" src="https://github.com/user-attachments/assets/2e16239e-038a-4e3a-bbfb-b731be09763f" /> <img width="1899" height="930" alt="writing feedback" src="https://github.com/user-attachments/assets/4b9500ef-9d02-4b48-a6b1-5dcce101d5f8" /> <!-- This is an auto-generated description by cubic. --> --- ## Summary by cubic Adds a lightweight docs feedback widget so readers can rate a page and leave comments. Submissions are sent to GitHub Discussions via a GitHub App and link back to the discussion. - **New Features** - Page-level feedback UI on docs pages (Good/Bad + message), with local storage to prevent duplicate prompts and a “View on GitHub” link. - Optional block-level feedback (`FeedbackBlock`) for MDX sections when using Fumadocs’ remark plugin. - Server actions in `landing/lib/github.ts` create or comment on a discussion under the “Docs Feedback” category. - **Migration** - Create a GitHub App and set `GITHUB_APP_ID` and `GITHUB_APP_PRIVATE_KEY` (use `\n` for newlines on Vercel). - In GitHub Discussions, create a category named “Docs Feedback”. - Ensure the target repo/owner match the constants in `landing/lib/github.ts` (`better-auth/better-auth`). <sup>Written for commit 5c69f334cf6c67a66635bcbc2c9ecb6651f84d46. Summary will update on new commits.</sup> <!-- End of auto-generated description by cubic. --> --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
GiteaMirror added the pull-request label 2026-03-13 13:57:53 -05:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/better-auth#8042