Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Dec 15, 2025

The README.md instructed users to run npx mintlify dev from the docs/ directory, but docs.json is located in docs/public/, causing the command to fail.

Changes:

  • Updated local preview command from cd docs to cd docs/public
# Before (fails - docs.json not found)
cd docs
npx mintlify dev

# After (works - docs.json exists here)
cd docs/public
npx mintlify dev
Original prompt

This section details on the original issue you should resolve

<issue_title>Documentation: Incorrect Mintlify dev command path in README.md</issue_title>
<issue_description>## 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]</issue_description>

Comments on the Issue (you are @copilot in this section)

@thedotmack @iefnaf thanks for catching this! I'm throwing copilot on it, and in the meantime you can read the docs over at https://docs.claude-mem.ai - all updates to the docs folder get auto pushed there

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Copilot AI changed the title [WIP] Fix incorrect Mintlify dev command path in README Fix Mintlify dev command path in README.md Dec 15, 2025
Copilot AI requested a review from thedotmack December 15, 2025 04:18
@thedotmack thedotmack marked this pull request as ready for review December 15, 2025 06:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Documentation: Incorrect Mintlify dev command path in README.md

3 participants