> ## Documentation Index
> Fetch the complete documentation index at: https://docs.holydocs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Roadmap

Share your product roadmap with users and collect votes on planned features.

## Overview

The Roadmap feature gives you a public-facing board where users can see what you are working on, what is planned, and what has shipped. Readers can vote on items to signal which features matter most to them, giving you direct prioritization input from the people who use your product.

Access the roadmap from the **Roadmap** item under the Manage section in your project sidebar.

## Creating Roadmap Items

**Open the roadmap**

Navigate to **Roadmap** in the sidebar. The roadmap view displays items organized by status in a Kanban-style board.
  **Click New Item**

Click the **New Item** button or click the **+** icon in any status column to create an item in that status.
  **Fill in the details**

Complete the item fields: title, description, status, category, and optional target date.
  **Publish**

Click **Save** to add the item to the roadmap. It becomes visible on your public roadmap page immediately after the next deployment.

### Item Fields

| Field | Required | Description |
|---|---|---|
| **Title** | Yes | A clear, concise name for the feature or initiative |
| **Description** | No | Detailed explanation of the item. Supports MDX content with HolyDocs components. |
| **Status** | Yes | Current stage of the item (see statuses below) |
| **Category** | No | Group items by product area or theme |
| **Target date** | No | Estimated delivery date. Displayed as a month/quarter label, not an exact date. |
| **Priority** | No | Internal priority level (Low, Medium, High, Critical). Not shown publicly by default. |

## Roadmap Statuses

Every roadmap item has one of four statuses. Items flow through these statuses as work progresses:

| Status | Color | Description |
|---|---|---|
| **Planned** | Blue | Under consideration or accepted for future work |
| **In Progress** | Amber | Actively being worked on |
| **Completed** | Green | Shipped and available |
| **Cancelled** | Gray | Will not be implemented. Remains visible with an explanation. |

Move items between statuses by dragging them across columns in the Kanban view, or change the status in the item detail panel.

### Status Workflow

```
Planned → In Progress → Completed
                     ↘ Cancelled
```

Items typically start as **Planned**, move to **In Progress** when development begins, and end as **Completed** or **Cancelled**. There is no enforced workflow — you can move items to any status at any time.

## Categories and Tags

Categories group related roadmap items together. Readers can filter the roadmap by category to see only the items relevant to them.

### Creating Categories

In the roadmap settings (gear icon at the top of the roadmap page), add categories that match your product areas:

| Example Categories | Use Case |
|---|---|
| **Editor** | Improvements to the writing experience |
| **AI Features** | AI assistant, search, and agent capabilities |
| **API** | REST API and OpenAPI tooling |
| **Integrations** | Third-party service connections |
| **Performance** | Speed, caching, and infrastructure |
| **Enterprise** | SSO, RBAC, audit logs, and compliance |

Categories are shared across all roadmap items. You can rename or merge categories at any time without affecting existing items.

## User Voting

When the roadmap page is enabled on your doc site, readers can vote on items to express interest.

### How Voting Works

- Each reader gets **one vote per item** (toggle on/off)
- Vote counts are displayed on each roadmap card
- Readers do not need to sign in to vote (votes are tracked by a privacy-friendly anonymous identifier)
- If your docs have authentication enabled, votes are tied to user accounts for deduplication

### Viewing Vote Data

In the dashboard, each roadmap item displays its total vote count. You can sort the roadmap by votes to surface the most-requested features.

The roadmap list view includes a **Votes** column that you can sort in ascending or descending order. Use this to inform your prioritization decisions.

Vote data is available via the HolyDocs API. Use the `GET /api/v1/roadmap?sort=votes` endpoint to retrieve items sorted by popularity.

## Roadmap Page on Your Doc Site

When the roadmap feature flag is enabled (see **Settings > Advanced**), a `/roadmap` page is added to your documentation site.

The public roadmap page includes:

- **Kanban board view** — Items displayed in columns by status
- **List view** — A compact list with status badges, vote counts, and categories
- **Category filter** — Dropdown to filter by product area
- **Status filter** — Toggle which status columns are visible
- **Vote buttons** — Readers can upvote items directly from the page
- **Item detail modal** — Clicking an item opens a modal with the full description

### Customizing the Roadmap Page

Control what is shown publicly in the roadmap settings:

| Setting | Description |
|---|---|
| **Show vote counts** | Display the number of votes on each item (default: on) |
| **Show target dates** | Display estimated delivery dates (default: off) |
| **Show cancelled items** | Include cancelled items on the public page (default: off) |
| **Allow voting** | Enable or disable the voting feature (default: on) |

## Embedding Roadmap in Documentation

Reference your roadmap from documentation pages to drive engagement:

```mdx
## What's Coming Next

Check out our [public roadmap](/roadmap) to see what we're working on
and vote on the features that matter most to you.

Interested in a feature that's not listed?
[Submit a suggestion](/roadmap?suggest=true) and we'll review it.
```

You can also link directly to a specific roadmap item:

```mdx
We're currently working on [dark mode improvements](/roadmap/dark-mode-v2).
```

## Managing and Prioritizing Items

### Editing Items

Click any item in the roadmap board or list to open the detail panel. Edit any field and click **Save**. Changes are reflected on the public roadmap after the next deployment.

### Bulk Status Updates

Select multiple items using the checkboxes in list view, then use the **Bulk actions** dropdown to change status, category, or delete items in a single operation.

### Archiving Completed Items

Completed items remain on the roadmap by default. To keep the board clean, use the **Archive** action to move completed items off the active board. Archived items are still accessible from the **Archived** tab in the dashboard.

### Prioritization Tips

**Use votes as a signal, not a decision**

Vote counts indicate user interest but should be weighed alongside strategic goals, technical feasibility, and business impact. A feature with 50 votes may matter less than a security fix with 3 votes.
  **Keep the roadmap honest**

Only add items you genuinely intend to consider. A roadmap full of items that never move erodes trust. If priorities change, move items to Cancelled with a brief explanation rather than silently removing them.
  **Update regularly**

A stale roadmap is worse than no roadmap. Set a cadence — weekly or biweekly — to review statuses and move items forward. Readers notice when items stay in "In Progress" for months.
  **Celebrate completions**

When you move an item to Completed, pair it with a changelog entry. This closes the loop for readers who voted and reinforces that their input leads to action.