Skip to main content
This repository is prepared for a Mintlify documentation site. Published handbook pages are MDX-first, while GitHub-only operating files such as README.md, CONTRIBUTING.md, SECURITY.md, and SUPPORT.md remain Markdown.

​
Local Preview

Mintlify requires Node.js 20.17.0 or newer for the current CLI. Run a local preview from the repository root: 
npx mint dev
Run quality checks before publishing: 
npx mint validate
npx mint broken-links

​
Deployment

The primary Mintlify deployment should be connected through the Mintlify GitHub app. Mintlify reads docs.json and publishes the documentation site when changes are pushed. If the handbook should appear under a Vercel-owned domain, configure Vercel as a reverse proxy after the Mintlify subdomain exists: 
{
  "rewrites": [
    {
      "source": "/docs",
      "destination": "https://YOUR-MINTLIFY-SUBDOMAIN.mintlify.dev/docs"
    },
    {
      "source": "/docs/:match*",
      "destination": "https://YOUR-MINTLIFY-SUBDOMAIN.mintlify.dev/docs/:match*"
    }
  ]
}
Do not add that active vercel.json until the real Mintlify subdomain is known.

​
Compatibility Policy

Mintlify is the student-facing reading layer. It should publish curated MDX pages, not every raw project artifact.
Artifact typeRepository policyWebsite policy
MDX pagesCommit and maintain as source documentationPublish curated pages through docs.json
GitHub operating MarkdownKeep only for GitHub-native surfaces such as README, contributing, support, security, and templatesLink from the site only when needed
Python sourceCommit as starter/source codeLink from guide pages or convert selected files into tutorial pages later
Jupyter notebooksKeep out of the handbook repo unless deliberately promotedConvert selected notebooks to MDX before publishing as lessons
HTML/CSS/JS examplesCommit when they are source or demosLink to GitHub or host curated demos separately
Built HTML/output filesAvoid publishing by defaultHost separately only when intentionally promoted as a demo
Raw referencesKeep outside the published site and ignored by this repo by defaultKeep out of the public docs site with .mintignore
The raw references/ archive is intentionally ignored by the repository-level .gitignore. Promote selected material into MDX pages when it is ready for the student-facing site.