Skip to main content

Overview

ZeroStarter includes optional integration for collecting user feedback. When configured, feedback links appear in two locations:
  1. Docs Sidebar Footer: A feedback link appears in the docs sidebar footer
  2. Dashboard User Menu: A feedback option appears in the user dropdown menu in the dashboard sidebar
Both locations allow users to submit feedback and only appear when the feedback URL is configured.

Setup

1
Configure Environment Variable
2
Add your feedback URL to your .env file:
3
# Optional: User feedback
NEXT_PUBLIC_USERJOT_URL=https://your-feedback-service.com
4
Environment Configuration
5
The feedback URL is configured in packages/env/src/web-next.ts:
6
client: {
  NEXT_PUBLIC_USERJOT_URL: z.url().optional(),
}
7
Verify Integration
8
The feedback links will automatically appear in both locations when NEXT_PUBLIC_USERJOT_URL is set. If the variable is not set or is empty, the links will not be displayed.

Features

  • Docs Sidebar Footer: Feedback link appears in the docs sidebar footer
  • Dashboard User Menu: Feedback option appears in the user dropdown menu (between user info and logout)
  • Optional: Only loads when NEXT_PUBLIC_USERJOT_URL is configured
  • External Link: Opens feedback URL in a new tab
  • Zero Impact: No performance impact when not configured

Disabling Feedback

To disable the feedback links, simply remove or leave empty the NEXT_PUBLIC_USERJOT_URL environment variable:
.env
# Feedback disabled
NEXT_PUBLIC_USERJOT_URL=
The links will not be rendered in either location, ensuring zero performance impact when not in use.

Feedback Services

You can use any feedback collection service that provides a URL endpoint. Some popular options:
  • UserJot: Simple feedback widget
  • Canny: Feature request and feedback management
  • Typeform: Custom feedback forms
  • Google Forms: Free and simple
  • Custom Solution: Build your own feedback endpoint

Implementation Example

The feedback URL is used in conditional rendering:
import { env } from "@packages/env/web-next"

export function FeedbackLink() {
  if (!env.NEXT_PUBLIC_USERJOT_URL) return null

  return (
    <a
      href={env.NEXT_PUBLIC_USERJOT_URL}
      target="_blank"
      rel="noopener noreferrer"
    >
      Send Feedback
    </a>
  )
}
The feedback integration is completely optional and has zero impact on performance when not configured.

Best Practices

  1. Use HTTPS: Always use secure URLs for feedback services
  2. Test the link: Verify the feedback URL opens correctly
  3. Monitor responses: Regularly check and respond to feedback
  4. Privacy: Ensure your feedback service complies with privacy regulations
  5. User experience: Keep the feedback form simple and quick to fill out

Build docs developers (and LLMs) love