Create a help center - Mintlify

Start from a template

The fastest way to create a new help center is with the mint new --template command. Run the command and select the help center starter template.

mint new your-help-center-name --template help-center-starter

This creates a new project pre-configured for a help center, including navigation structure, sample pages, and directory listings. See the live example or browse the template source. If you prefer to configure a help center in an existing project, continue with the steps below.

Prerequisites

If you haven’t created a Mintlify project yet, see the Quickstart to deploy your site.

Content for your most common support topics
Admin access to your Mintlify organization
Domain for hosting your help center: a custom domain or your default .mintlify.site URL

Migrate existing content

If you’re creating a help center from scratch, skip to Plan your help center structure.

Audit existing content

Review your current support resources to understand what to migrate.

Help articles: What topics do you address? Which articles get the most views?
FAQs: Do you have frequently asked questions that should become articles?
Support tickets: What questions do customers ask repeatedly? These should become self-service content.
Product documentation: Is there overlap between support content and product docs?

Export your existing content

Export to Markdown for the simplest migration to Mintlify.
Export to HTML if Markdown isn’t available, then convert to Markdown.
Export ticket data to identify common questions that need documentation.

Plan your help center structure

Organize your help center around customer problems, not product features. Customers arrive with questions and goals, so structure content that aligns with how they think about your product and common tasks.

Review your support tickets to understand what customers actually ask about. This helps you prioritize content and structure navigation around real problems.

Use the directory property to create index pages for each group in your navigation. When you use the directory property, every root page displays a directory listing for the other pages in the same navigation group. This gives customers an overview of the content in each section that they can click through to the specific pages they need. Set directory to "card" for a horizontal card layout or "accordion" for a list. The value passes down through the navigation tree unless you specifically override it on a later level.

Example navigation structure

{
  "navigation": {
    "directory": "card",
    "groups": [
      {
        "group": "Get Started",
        "root": "getting-started/index",
        "pages": [
          "getting-started/quick-setup",
          "getting-started/first-steps"
        ]
      },
      {
        "group": "Account",
        "root": "account/index",
        "pages": [
          "account/billing",
          "account/plans",
          "account/team-management",
          "account/security"
        ]
      },
      {
        "group": "Using the Product",
        "root": "product/index",
        "pages": [
          "product/feature-one",
          "product/feature-two",
          "product/integrations"
        ]
      },
      {
        "group": "Troubleshooting",
        "root": "troubleshooting/index",
        "pages": [
          "troubleshooting/common-errors",
          "troubleshooting/connectivity",
          "troubleshooting/performance"
        ]
      }
    ]
  }
}

Write effective support content

Support content should help customers solve problems quickly. Every article should answer one specific question or solve one specific problem. Organize related content into groups instead of creating overly long pages that have too much information.

Structure articles for scanning

Customers scan support pages looking for their specific issue. Use clear headings and short paragraphs.

Example support page

---
title: "Fix login issues"
description: "Troubleshoot common problems signing in to your account"
---

## Reset your password

If you forgot your password, request a reset link from the login page.

1. Go to the login page.
2. Click **Forgot password**.
3. Enter your email address.
4. Check your inbox for the reset link.

## Clear browser cache

Old cached data can cause login problems. Clear your browser cache and try again.

## Check account status

If your account is suspended or deactivated, you'll see an error when logging in. Contact support if you believe this is a mistake.

Include step-by-step instructions

When explaining how to do something, use numbered steps.

Go to Settings Click the gear icon in the toolbar.
Select Billing Click Billing in the navigation menu.
Update payment method Click Update next to your current payment method and enter new details.

Add visual aids

Screenshots and diagrams help customers confirm they’re in the right place.

Example screenshot

Set up the assistant

The assistant answers customer questions using your support content. Configure it from your dashboard.

Add sample questions Add common questions customers ask, such as:
- “How do I cancel my subscription?”
- “Why was my payment declined?”
- “How do I add team members?” Sample questions appear as quick-access buttons, helping customers get answers with one click.
Set a deflection email Configure a support email for questions the assistant can’t answer. This ensures customers can still reach your team when self-service isn’t enough.
Review conversations Check assistant conversations regularly to identify:
- Questions the assistant can’t answer (content gaps)
- Incorrect or incomplete answers (content to improve)
- Common question patterns (content to prioritize)

Enable feedback collection

Feedback helps you understand which pages are helpful and which need improvement. Review feedback to see which pages customers find helpful and which need improvement. Read all comments and update pages based on valid feedback.

Set up analytics

Monitor the analytics in your dashboard to see how customers use your help center and improve content over time.

Popular articles: Which articles get the most views? Keep these accurate and well-maintained.
Search queries: What do customers search for? Create content for common searches that return no results.
Assistant conversations: What questions does the assistant receive? Use this to identify content gaps.

Restrict content by customer segment

If you have different customer tiers or product plans, show relevant content to each segment using group-based access control.

Set up authentication Configure authentication to identify customers when they visit your help center.
Configure user groups Return group information in your user data to define customer segments based on plan type, account status, or other attributes. See User data format for details.
Tag content by group Use frontmatter to specify which groups can see each article.

---
title: "Enterprise SSO setup"
groups: ["enterprise"]
---

Maintain your help center

Support content becomes outdated as your product changes. Establish processes to keep content accurate.

Update with product releases When you ship product changes, update affected support articles. Include documentation updates in your release process.
Review feedback regularly Check article ratings and customer feedback weekly. Address negative feedback promptly. It often indicates confusing or incorrect content.
Monitor support tickets If customers submit tickets for issues covered in your help center, investigate why self-service didn’t work. The article might be hard to find, unclear, or incomplete.
Archive outdated content Remove or archive articles about deprecated features. Outdated content confuses customers and reduces trust in your help center.

Next steps

Your help center is ready to launch. After deploying:

Link to your help center from your product and website.
Monitor assistant conversations and search queries to find content gaps.
Review feedback ratings weekly and improve low-rated articles.
Track ticket volume to measure self-service effectiveness.

A good help center reduces support costs while improving customer satisfaction. Invest in content that answers common questions effectively.