Use this guide to preview the docs on your machine and create new content.

​
Prerequisites

  • Node.js 18 or newer
  • This folder (wupxy-docs) open in your terminal

​
Preview locally

1

Open the docs folder

cd /Users/wupxy/WORK/Code/website/wupxy-workspace/wupxy-docs
2

Start Mintlify dev server

npx mintlify dev
The docs open at http://localhost:3000 with hot reload.
3

Check for broken links before publishing

npx mintlify broken-links

​
Add a new page

  1. Create a .mdx file in the relevant folder (e.g. workflows/my-new-guide.mdx)
  2. Add frontmatter at the top:
---
title: "Page title"
description: "What the reader can do after reading this page."
icon: "icon-name"
---
  1. Add the page path to the correct group in docs.json under navigation.tabs
See Page Conventions for the full frontmatter schema and component guide.

​
Build and deploy

npm run build
This exports a static site to dist/. Vercel picks this up automatically on push.

Page Conventions

Frontmatter schema, available components, and naming conventions for new pages.