Documentation
Everything you need to set up and get the most out of Roadmapr.
Quick Start
Go from zero to live roadmap in 5 minutes
Create your account
Sign up at roadmapr.in/auth/signup. No credit card required for the Free plan. Verify your email and you're in.
Create your first project
Click "New Project" in your dashboard. Give it a name (e.g., "MyApp Roadmap") and choose a URL slug. Your public roadmap will be live at roadmapr.in/your-slug instantly.
Add your first features
Click "Add Feature" to create your first roadmap item. Give it a title, description, and set a status: Planned, In Progress, or Shipped. Features are visible to your users immediately.
Share your roadmap
Share roadmapr.in/your-slug with your users via email, in-app notifications, or social media. Users can browse, vote on features, and submit new ideas.
Managing Features
Add, organize, and prioritize your feature backlog
Feature statuses
Every feature has one of three statuses: Planned (you're considering it), In Progress (actively building), or Shipped (done!). Moving a feature to Shipped triggers changelog entries and WhatsApp notifications to voters (on Pro+).
Tags and categories
Use tags to organize features by area (e.g., "UI", "API", "Mobile"). Users can filter the roadmap by tag to find what's relevant to them.
Approving user submissions
Users can submit feature ideas. These go into a moderation queue. Review them in your dashboard and approve the ones worth tracking. Approved features become voteable by your community.
Prioritization by votes
Sort your feature list by vote count to see what your users want most. Use this as your north star for sprint planning — build what your users are literally voting for.
Embedding Your Roadmap
Add your roadmap to any website with one script tag
Get your embed code
Go to Dashboard → Widget. Copy your embed code. It looks like: <script src="https://roadmapr.in/widget.js" data-project="your-slug"></script>
Add to your website
Paste the script tag before </body> on any HTML page, or in your Next.js _document.tsx / layout.tsx. The widget loads asynchronously and doesn't slow your page.
Widget modes
Choose between Inline (embedded in a div), Floating Button (appears as a floating tab), or Modal (opens as a popup). Configure colors to match your brand in the widget settings.
React / Next.js integration
Import our React component: npm install @roadmapr/widget. Then use <RoadmaprWidget project="your-slug" theme="dark" /> anywhere in your component tree.
Changelog & Announcements
Celebrate every ship and keep users informed
Creating changelog entries
Go to Dashboard → Changelog → New Entry. Write a title, description (markdown supported), and tag the type: Feature, Improvement, or Bug Fix. Rich text editor included.
Linking features to changelog
When you ship a feature, link it to a changelog entry. This automatically moves the feature to "Shipped" status and notifies voters via WhatsApp (Pro+) or email.
Public changelog URL
Your public changelog is available at roadmapr.in/your-slug/changelog. Share this link in your newsletter, social media, or in-app notifications.
Custom Domain Setup
Use roadmap.yourapp.com (Pro & Business)
Add your domain
Go to Dashboard → Settings → Custom Domain. Enter your subdomain (e.g., roadmap.yourapp.com) and click "Add Domain".
Configure DNS
Add a CNAME record at your DNS provider: roadmap → roadmapr.in with TTL 300. DNS propagation takes 5–60 minutes.
SSL is automatic
We provision a free SSL certificate via Let's Encrypt automatically. Your custom domain will be live at https://roadmap.yourapp.com within 60 minutes of DNS propagation.
API Reference
Integrate Roadmapr into your own systems (Business plan)
Authentication
Generate an API key in Dashboard → Settings → API Keys. Include it in requests as: Authorization: Bearer YOUR_API_KEY
Core endpoints
GET /api/v1/features — List all features with vote counts POST /api/v1/features — Create a feature programmatically PATCH /api/v1/features/:id — Update status, title, or description POST /api/v1/changelog — Publish a new changelog entry
Webhooks
Receive real-time notifications when features are voted on, submitted, or shipped. Configure webhook URLs in Dashboard → Settings → Webhooks. We send POST requests with a JSON payload and an HMAC signature for security.