Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 19 additions & 20 deletions help-center/getting-started/billing/compare-plans.mdx
Original file line number Diff line number Diff line change
@@ -1,35 +1,34 @@
---
title: "Compare plans"
title: "Compare Mintlify plans"
sidebarTitle: "Compare plans"
description: "Feature matrix across Free, Team, and Enterprise tiers for this demo help center."
description: "Feature comparison across Mintlify's Starter, Growth, and Enterprise plans."
---

Plans bundle limits, support, and compliance features. Use this page to shortlist options before legal review—exact numbers change, but the pattern usually holds: pay for seats, automation volume, and the audit artifacts you need.
Mintlify offers plans for teams at every stage. All plans include unlimited pages, deployments, and the full component library.

## Highlights
## Plan highlights

- **Free** — Core projects and limited automation runs. Best for evaluation and tiny teams with light automation.
- **Team** — SSO options, higher limits, and priority email support. Common step after product-market fit when coordination overhead grows.
- **Enterprise** — Regional options, advanced audit, and dedicated support channels. Typical when procurement, security questionnaires, or data residency enter the conversation.

### Hidden costs

Count integrations, API volume, and retained history—not just seats. A team on paper may exceed automation quotas during a busy quarter.
- **Starter** — One project, community support, and `*.mintlify.app` hosting. Best for individuals and early-stage products getting their first docs site live.
- **Growth** — Multiple projects, custom domains, analytics, AI search, password protection, and priority support. The right tier for most teams shipping a real product.
- **Enterprise** — SSO, audit logs, SLA guarantees, custom contracts, dedicated support, and advanced security controls. For teams with procurement, compliance, or data residency requirements.

## How to choose

Start where your current limits hurt first—usually automation volume or member count—then add Enterprise when procurement or compliance requires it.
Start with Starter to validate the workflow, then upgrade when you need custom domains, analytics, or team collaboration features. Upgrade to Enterprise when security questionnaires, SSO, or a signed DPA enter the conversation.

### Proof points
## Common questions

Before upgrading, reproduce one painful workflow in a trial project and measure time saved. Finance teams respond to minutes per week reclaimed, not feature lists alone.
**Can I use a custom domain on Starter?**
Custom domains require the Growth plan or above.

## Pilot checklist
**Does Mintlify charge per seat?**
Mintlify pricing is project-based, not per seat — you can invite as many editors as you need without per-user fees.

- Confirm how many seats you truly need after removing inactive accounts.
- List must-have integrations and confirm they are included or priced as add-ons.
- Align legal and security on DPA, subprocessors, and data residency before you sign.
**Can I try Growth features before upgrading?**
Contact [support](mailto:support@mintlify.com) to request a trial of Growth features for your team.

## When to revisit
## Before upgrading

Re-evaluate plans at major milestones: funding rounds, geographic expansion, or a spike in automation usage after a new workflow goes live. Annual true-ups catch drift between contract and reality.
- Confirm your repository setup and first deployment are working on Starter.
- Check whether you need a custom domain, analytics, or AI search — those are the main Growth additions.
- For Enterprise, loop in your legal and security teams early — DPA review and SSO setup add lead time.
6 changes: 3 additions & 3 deletions help-center/getting-started/billing/index.mdx
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
title: "Billing and plans"
sidebarTitle: "Overview"
description: "Plans, invoices, and upgrades for your workspace."
description: "Mintlify plans, pricing, and how billing works for your organization."
---

Billing is tied to your organization. This section explains how plans compare, how changes propagate, and where to find invoices.
Mintlify billing is tied to your organization. One subscription covers all projects under the organization, and all Admins can access billing settings.

If you need a custom agreement, contact sales from the billing page—dummy numbers here are for demonstration only.
Use the articles in this section to compare plans, manage your subscription, and find invoices.
34 changes: 19 additions & 15 deletions help-center/getting-started/billing/invoices-receipts.mdx
Original file line number Diff line number Diff line change
@@ -1,31 +1,35 @@
---
title: "Invoices and receipts"
sidebarTitle: "Invoices & receipts"
description: "Download invoices, update tax details, and reconcile charges."
description: "Download invoices, update billing information, and reconcile charges."
---

Finance teams need clean paper trails: invoices for accruals, receipts for reimbursements, and tax IDs that match what is on file with vendors. Keep addresses and VAT numbers current before month-end close.
Invoices and payment history are available to Admins in **Settings → Billing → Invoices**.

## Where to find invoices
## Download invoices

Navigate to **Settings → Billing → Invoices** for PDF copies and line items. Download CSV or structured exports if your ERP ingests them automatically.
Each invoice is available as a PDF with a line-item breakdown. Click **Download** next to any invoice in the invoice list.

### Line items
Invoices include:
- Billing period
- Plan name and quantity
- Prorated charges or credits for plan changes mid-cycle
- Tax if applicable based on your billing address

Verify seat counts and add-ons against internal headcount reports. Discrepancies often trace to deactivated users still occupying paid seats until the next true-up.
### Updating your billing address or tax ID

## Tax and VAT
Update your billing details in **Settings → Billing → Billing information** before your next renewal. Mintlify can reissue invoices if your tax ID was missing at the time of the charge — contact [support](mailto:support@mintlify.com) with the invoice number and the correct details.

Update tax IDs before renewal to avoid delays. This demo does not constitute tax advice—run final numbers past your accounting partner, especially for cross-border entities.

### Reverse charge and treaties
## Receipts

Document which party remits VAT or sales tax for each entity. Store evidence with the invoice PDF for audit readiness.
Stripe sends an email receipt to your billing address after each successful charge. Receipts are suitable for expense reporting.

## Receipts
If the receipt didn't arrive, check your billing email's spam folder, or download the invoice PDF from the dashboard — both contain the charge amount and date.

Card charges include a receipt link suitable for expense tools that accept emailed PDFs. Forward receipts immediately after charge—matching six months later is painful.
## Failed payments

### Corporate cards
If a charge fails, Mintlify retries automatically and notifies the billing contact by email. Update your payment method in **Settings → Billing → Payment method** before the retry window closes to avoid service interruption.

If the cardholder rotates, update billing profiles so receipts reach the person who must attest to expenses.
<Info>
Mintlify uses Stripe for payment processing. If your finance team needs Stripe's supplier information for vendor onboarding, contact [support](mailto:support@mintlify.com).
</Info>
31 changes: 18 additions & 13 deletions help-center/getting-started/billing/upgrade-downgrade.mdx
Original file line number Diff line number Diff line change
@@ -1,31 +1,36 @@
---
title: "Upgrade or downgrade your plan"
sidebarTitle: "Upgrade or downgrade"
description: "Change plans, proration, and limit changes for subscriptions."
description: "How plan changes work, what happens to your features, and when changes take effect."
---

Plan changes affect billing, feature gates, and sometimes data retention. Read the fine print on your order form—this article describes typical patterns for illustration only.
Plan changes are made by an Admin in **Settings → Billing**.

## Upgrade

Upgrades take effect immediately in this template content. Proration is calculated against your billing cycle for illustration.
Upgrades take effect immediately. You gain access to the new plan's features right away, and your card is charged a prorated amount for the remainder of the current billing period.

### Capacity planning
### After upgrading

After upgrading, revisit automation and storage settings—you may need to raise internal quotas now that platform limits moved.

### Communication

Tell finance when upgrades happen mid-cycle so invoices match purchase orders. Link to the order confirmation in your ticket.
- **Custom domains** — You can configure custom domains for your projects right after upgrading.
- **Analytics** — The analytics dashboard becomes available immediately. Historical data from before the upgrade is not backfilled.
- **AI search** — Enable AI search per project in project settings after upgrading to Growth.

## Downgrade

Downgrades apply at the next renewal unless your contract states otherwise. Features above the new cap become read-only until you adjust usage.
Downgrades take effect at the end of your current billing period. Until then, you continue to have access to all current plan features.

### Export first
When the downgrade takes effect:
- Custom domains are disabled — your site will redirect to its `*.mintlify.app` URL.
- Analytics and AI search features become unavailable.
- The site itself stays live and deployments continue.

Download critical exports before downgrade if retention windows shrink. You cannot always rely on grace periods for compliance archives.
### Before downgrading

Export any analytics data you want to keep — historical data is not accessible after downgrading.

## Billing contacts

Ensure finance and IT stakeholders are copied on invoices if your organization requires it. Rotate contacts when owners change roles—stale addresses delay tax validation and payment.
Make sure the billing email on file in **Settings → Billing** is monitored. Invoices, receipts, and renewal notices go to that address.

If your billing contact changes (someone leaves, finance wants a shared inbox), update the billing email before the next renewal cycle.
35 changes: 20 additions & 15 deletions help-center/getting-started/create-account.mdx
Original file line number Diff line number Diff line change
@@ -1,32 +1,37 @@
---
title: "Create your account"
title: "Create your Mintlify account"
sidebarTitle: "Create account"
description: "Sign up, verify your email, and choose the right organization type for your team."
description: "Sign up, connect your Git provider, and set up your organization."
---

Creating an account should take minutes. The decisions that matter—company vs personal workspace, who pays, and which email domain owns the org—are easier to correct now than after you have invited dozens of people.
Getting started with Mintlify takes a few minutes. The key decisions — which Git provider to use, who manages billing, and how your organization is named — are easiest to get right up front.

## Sign up

Visit the signup page and enter your work email. We send a one-time link to verify ownership of the address. Links expire; request a fresh one if your inbox is slow.
Go to [mintlify.com/start](https://mintlify.com/start) and sign up with your work email or GitHub account. If you sign up with email, we send a verification link — check your spam folder if it doesn't arrive within a minute.

### Domains and policy
### Work email vs GitHub

Some companies block consumer email providers. If signup fails silently, try your corporate domain or ask IT to allow the notification sender.
Signing up with GitHub is faster and connects your account to your repositories immediately. Work email is preferred if your organization has SSO policies that require it.

## Organization type
## Create your organization

- **Company** — Multiple teams under one billing profile. Choose this when finance expects a single invoice and you want shared administration.
- **Personal** — Individual use with the option to upgrade later. Appropriate for evaluation before you commit a legal entity.
After signing in, you'll be prompted to create an organization. Your organization name appears in the Mintlify dashboard and in email notifications to teammates.

### Switching later
- Use a recognizable name — your company name or product name work well.
- Avoid internal codenames if external collaborators will see it.

Moving between types may require support or export/import if your product separates billing identities. When in doubt, start as **Company** if you know you will onboard a team within a month.
## Connect your Git provider

## Verification issues
Mintlify deploys from your Git repository. During setup, you'll install the Mintlify GitHub App (or connect GitLab). Grant it access to the repositories you plan to use for documentation.

If the email does not arrive within a few minutes, check spam folders and ensure your IT allowlist includes notification domains. Corporate filters sometimes delay the first message more than subsequent ones.
<Info>
You can install the GitHub App on an individual account or a GitHub organization. If your docs repository belongs to a GitHub organization, install the app on that organization so all members can collaborate.
</Info>

### Shared inboxes
## Verification issues

Avoid signing up with distribution lists—you lose account recovery if nobody owns the mailbox. Prefer a named admin who can delegate later.
If the verification email doesn't arrive:
- Check your spam and promotions folders.
- Ask your IT team whether the Mintlify sender domain is filtered.
- Try signing up with GitHub instead if email delivery is unreliable in your environment.
6 changes: 3 additions & 3 deletions help-center/getting-started/index.mdx
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
title: "Getting started"
sidebarTitle: "Overview"
description: "Create your account, secure access, and connect the product to the tools your team already uses."
description: "Create your account, deploy your first docs site, and connect your team in minutes."
---

Welcome. This section walks you through account setup, your workspace, billing, and integrations so you can get productive quickly.
Welcome to Mintlify. This section covers everything you need to go from signup to a live, deployed docs site with your team contributing.

Use the articles below to go deeper—each guide is written for busy teams who need clear steps without fluff.
Use the articles below to move at your own pace — most teams are live within an hour.
46 changes: 26 additions & 20 deletions help-center/getting-started/integrations/connect-crm.mdx
Original file line number Diff line number Diff line change
@@ -1,32 +1,38 @@
---
title: "Connect your CRM"
sidebarTitle: "CRM"
description: "Link Salesforce or HubSpot through partner connectors or a custom sync strategy."
title: "Connect your repository"
sidebarTitle: "Repository"
description: "How Mintlify connects to GitHub and GitLab to deploy your docs."
---

CRM integrations keep customer context next to internal work. The hardest part is agreeing which system owns which field—decide that before you flip the sync on.
Mintlify deploys directly from your Git repository. Connecting your repository is the first step to getting your docs site live.

## Supported paths
## GitHub

- Official partner connectors (see partner guides)
- CSV or API-based sync via developer tools
<Steps>
<Step title="Install the GitHub App">
During signup (or from **Settings → Integrations → GitHub**), click **Install GitHub App**. Choose the GitHub organization or personal account where your docs repository lives.

### When to use each
Grant the app access to the specific repository (or all repositories, if you prefer). Mintlify only reads your repository content — it does not write to your repo.
</Step>
<Step title="Select your repository">
After installing the app, return to the Mintlify dashboard and select the repository to use for your project. Mintlify clones the repo and starts the first build.
</Step>
<Step title="Configure your default branch">
By default, Mintlify deploys from your repository's default branch (usually `main`). You can change the deployment branch in **Project Settings → Git**.
</Step>
</Steps>

Partner connectors trade flexibility for speed. Custom sync suits unusual object models or heavy transformations mid-pipeline.
## GitLab

## Data expectations
GitLab integration uses a webhook instead of an app:

Define which objects sync and how conflicts resolve. Document owner fields so automation behaves predictably.
1. In your Mintlify project settings, go to **Settings → Git → GitLab**.
2. Copy the provided webhook URL and secret.
3. In your GitLab repository, go to **Settings → Webhooks** and add the URL and secret.
4. Enable the **Push events** trigger.

### Conflict rules
Mintlify will deploy whenever you push to the configured branch.

“CRM wins” vs “product wins” should be explicit for every field. Ambiguity shows up first when sales reassigns accounts during a territory change.
## Monorepos

## Privacy

Limit synced fields to the minimum needed for your workflows and review access regularly.

### Retention

Align deletion policies: when a CRM record disappears, decide whether related artifacts should archive, anonymize, or remain linked for audits.
If your documentation lives in a subdirectory of a larger repository, set the **Docs root** in **Project Settings → Git** to the path of the subdirectory (for example, `docs/`). Mintlify will treat that directory as the root of your docs site.
42 changes: 26 additions & 16 deletions help-center/getting-started/integrations/connect-slack.mdx
Original file line number Diff line number Diff line change
@@ -1,31 +1,41 @@
---
title: "Connect Slack"
title: "Slack notifications"
sidebarTitle: "Slack"
description: "Install the Slack app, pick channels, and manage notifications."
description: "Get deployment notifications and alerts in your Slack workspace."
---

Slack puts updates where people already work. A disciplined channel strategy keeps signal high—one noisy channel trains everyone to mute the integration entirely.
Connect Mintlify to Slack to receive notifications about deployments, failed builds, and other project activity directly in your channels.

## Install
## Set up Slack notifications

From **Integrations → Slack**, authorize the workspace you use every day. You need admin approval if your Slack org restricts apps.
Mintlify can send deployment status updates to Slack via a webhook. The most common setup routes these through GitHub or GitLab Actions.

### Scopes
### Using GitHub Actions

Review requested OAuth scopes during install. If something looks broader than needed, ask your Slack admin whether a reduced app configuration exists.
Add a Slack notification step to your CI workflow that fires after Mintlify deploys:

## Channels
```yaml
- name: Notify Slack on deploy
uses: slackapi/slack-github-action@v1
with:
payload: |
{
"text": "Docs deployed: ${{ github.event.head_commit.message }}"
}
env:
SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
```

Map events to public or private channels. Start with a low-noise channel for pilot testing.
Store your Slack webhook URL as a GitHub Actions secret (`SLACK_WEBHOOK_URL`) — never hardcode it in the workflow file.

### Naming
### Channel strategy

Use a consistent prefix (`#help-`, `#docs-`) so people can browse related channels. Archive pilot channels after go-live to reduce clutter.
- Use a dedicated `#docs-deploys` channel for deployment notifications — this keeps the signal separate from other engineering noise.
- Reserve `@channel` mentions for failed builds or broken links, not routine deploys.

## Troubleshooting

If messages stop, reauthorize the app and confirm the bot was not removed from the channel.

### Rate limits

Bursty events can hit Slack posting limits—back off or batch summaries if you see `429` responses in integration logs.
If notifications stop:
- Confirm the webhook URL is still valid — Slack deactivates webhook URLs when a workspace app is removed.
- Check whether the bot was removed from the target channel.
- Re-create the webhook in **Slack → Apps → Incoming Webhooks** if needed.
Loading