Getting Started Introduction

Quick Start

Install DocPulse in your documentation site in less than two minutes. Turn your passive readers into active contributors with a drop-in component.

1. Installation

Install the package via your preferred package manager. We recommend npm or pnpm for Next.js projects.

Terminal
npm install @docpulse/react

2. Add to your Layout

Import the widget and place it inside your root layout or application shell. It will automatically inject a floating feedback button on every page.

app/layout.tsx
import { DocPulse } from '@docpulse/react';
export default function RootLayout({ children }: { children: React.ReactNode }) {
return (
<html lang="en">
<body>
{children}
<DocPulse
projectId="prj_YOUR_PROJECT_ID"
theme="dark"
/>
</body>
</html>
);
}
Where do I find my Project ID?

You can locate your Project ID in the Dashboard Settings under "Integration Keys". Ensure you keep this key safe.

3. Configure Webhooks

To send feedback directly to Slack, Discord, or Linear, set up a webhook in your project dashboard. No server code required.

Setup Integrations