mintlify-preview-workflow

Automate Mintlify preview deployments for pull requests and release branches.

7|2|Updated Jan 8, 2026
One-click install
npx skills add https://github.com/DomoApps/domo-documentation-hub --skill mintlify-preview-workflow
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: mintlify-preview-workflow
Source: https://github.com/DomoApps/domo-documentation-hub/tree/main/.claude/skills/mintlify-preview-workflow
Command: npx skills add https://github.com/DomoApps/domo-documentation-hub --skill mintlify-preview-workflow

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Managing Mintlify preview deployments for PRs and release branches can be error-prone and slow without automation, leading to wasted time on manual steps and inconsistent previews.

Core Features & Use Cases

  • Automates Mintlify preview deployments triggered by PRs and release-branch pushes.
  • Ensures deterministic previews with token-based authentication and project scoping.
  • Manages concurrency and provides clear feedback via sticky comments on PRs.

Quick Start

Create a PR or push to a release/** branch to initialize a Mintlify preview and observe the sticky comment with the preview URL.

Frequently Asked Questions about mintlify-preview-workflow

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I automate Mintlify preview deployments for GitHub pull requests?

Automating Mintlify preview deployments for pull requests involves triggering a webhook on PR events against any base branch, generating a deterministic preview URL, and posting it via a sticky comment on the PR.

Do I need MINTLIFY_TOKEN and MINTLIFY_PROJECT_ID to generate a preview URL?

Yes, generating a Mintlify preview URL requires MINTLIFY_TOKEN and MINTLIFY_PROJECT_ID to enforce security requirements and ensure deterministic, project-scoped authentication for each deployment.

How does this workflow handle Mintlify HTTP errors like 401, 403, or 429?

The workflow handles Mintlify HTTP errors by catching 400, 401, 403, and 429 responses and applying a cancel-in-progress strategy to manage concurrency and stay within rate limits.

What is the best way to manage Mintlify previews for release branch pushes?

Managing Mintlify previews for release branch pushes is best handled by triggering deployments on pushes to release/** branches and surfacing the single authoritative preview URL via a sticky comment on the relevant PR.

Can I use GitHub Actions CI/CD to post a Mintlify preview link as a PR comment?

Yes, you can use GitHub Actions CI/CD to post a Mintlify preview link as a PR comment by automating the webhook trigger and updating a sticky comment to ensure a single authoritative preview per change.

Why does my Mintlify preview deployment fail with concurrency rate limits?

Mintlify preview deployments fail with concurrency rate limits when too many builds run simultaneously, so the workflow applies a cancel-in-progress strategy to manage rate limits and ensure only the latest deployment proceeds.