Bad edit not caught on deployment.

[sidPhoenix17]

So a teammate added a wrong embedding snippet in one of the mdx files.

<div style="position: relative; padding-bottom: 64.86486486486486%; height: 0;"><iframe src="https://www.loom.com/embed/f54050e190cc46fbbaf10506694929a4?sid=cd450f8c-12e6-406e-9fbb-d1c89e7b5b8f" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;"></iframe></div>

instead of

<div className="relative pb-[64.86%] h-0">
  <iframe 
    src="https://www.loom.com/embed/f54050e190cc46fbbaf10506694929a4?sid=cd450f8c-12e6-406e-9fbb-d1c89e7b5b8f" 
    frameBorder="0" 
    webkitallowfullscreen 
    mozallowfullscreen 
    allowFullScreen 
    className="absolute top-0 left-0 w-full h-full"
  />
</div>

I fixed it but the fact is that the Mintlify Deployment got "successful" as per the dashboard:

Ideally this should have failed. But it didn't. That was a bit of a bummer as we there was no error message saying it's a bug.

Couple of trivial suggestions:

• Either improve the deployment logs?
• Create a readme file in the repo automatically on basic deployment checks for anyone new.. My teammate is not a native ts/js dev and wouldn't have intuitively figured out this flow. I ended up (using Cursor) to create a readme that looks really basic and like this

---

DrDroid Documentation

This repository contains the documentation for DrDroid, built using Mintlify - an AI-native documentation platform designed for developers.

Note: If you are trying to debug any error, always use context7 mcp server when using cursor for any changes so it can read mintlify docs and figure out how to fix it. (example prompt: i'm getting an error in this file.. can you fix this? if needed use context7 to get mintlify docs and understand how it can be done)

🚀 Quick Start

Prerequisites

• Node.js v19+
• npm, yarn, or pnpm

Installation

# Install Mintlify CLI globally
npm i -g mint

# Verify installation
mint --version

Local Development

# Start local development server
mint dev

# Preview will be available at http://localhost:3000

🧪 Testing & Validation

Before pushing code, run these commands to ensure documentation quality:

1. Check for Broken Links

# Scan for broken reference links
mint broken-links

2. Local Preview (Error Detection)

# Start dev server to catch build errors
mint dev
# Press Ctrl+C to stop after checking for errors

3. Package.json Scripts (Optional)

Add these to your package.json for convenience:

{
  "scripts": {
    "lint": "mint broken-links",
    "preview": "mint dev"
  }
}

Then run:

npm run lint
npm run preview

---

Ideally I would have asked him to figure it out but he's a small contributor to the docs and it was convenient to manage edits from ui previously (e.g. readme.io). I don't want to enforce them to learn this too!

Thank you!