Bug Description

The README.md contains an incorrect command for running Mintlify documentation locally.

Current Issue

In README.md line 99-102:

cd docs
npx mintlify dev

This fails with error: "error must be run in a directory where a docs.json file exists"

Root Cause

The docs.json file is actually located in docs/public/ directory, not docs/.

Evidence

• File location: ./docs/public/docs.json ✅
• Command tries: ./docs/docs.json ❌ (does not exist)

Suggested Fix

Update the command in README.md to:

cd docs/public
npx mintlify dev

Impact

• Users cannot easily preview documentation locally
• Reduces developer experience for contributors
• Affects documentation workflow

Environment

• File: README.md (lines 99-102)
• Affected section: Documentation → Local Preview
• Mintlify version: latest (via npx)

Steps to Reproduce

1. Clone the repository
2. Run cd docs
3. Run npx mintlify dev
4. Observe error about missing docs.json

Expected Behavior

The command should work and start the Mintlify dev server successfully.

Thank you for maintaining this great project! 🙏

🤖 Generated with Claude Code

Co-Authored-By: Claude [email protected]