Skip to content

Replace obsolete mintlify CLI commands with mint#44

Open
dimitristrechas wants to merge 2 commits intoTryGhost:mainfrom
dimitristrechas:main
Open

Replace obsolete mintlify CLI commands with mint#44
dimitristrechas wants to merge 2 commits intoTryGhost:mainfrom
dimitristrechas:main

Conversation

@dimitristrechas
Copy link

@dimitristrechas dimitristrechas commented Mar 11, 2026

This PR updates the README and CLAUDE markdown files to align with the current (as of 03/2026) Mintlify CLI command mint and Node.js requirements.


Note

Low Risk
Documentation-only updates to local development commands and stated Node.js prerequisites; no runtime or production code changes.

Overview
Updates contributor docs (README.md and CLAUDE.md) to use the current Mintlify CLI package/commands (npm i -g mint, mint dev, mint broken-links) instead of mintlify.

Refreshes local troubleshooting guidance by replacing mintlify install with clearing the local cache (rm -rf ~/.mintlify) and bumps the documented Node.js requirement to v20.17.0+.

Written by Cursor Bugbot for commit 58dcf91. This will update automatically on new commits. Configure here.

Update CLAUDE.md and README.md to use the new `mint` CLI instead of
`mintlify`, and update Node.js requirement to v20.17.0+.
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 11, 2026

Walkthrough

Documentation files were updated to replace Mintlify CLI commands with Mint equivalents (e.g., npm i -g mint, mint dev, mint broken-links). CLAUDE.md also updates the Node.js requirement to v20.17.0+, adds a new "Configuration" subsection describing docs.json, and expands "Architecture & Structure" with content organization details for /api-reference, /essentials, /snippets, /images, /logo, and key MDX files (index.mdx, quickstart.mdx, development.mdx). README.md receives matching CLI command updates. No code or exported/public API changes.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description check ✅ Passed The PR description directly addresses the changeset, explaining the replacement of mintlify CLI commands with mint, the installation instruction update, and Node.js requirement bump, with cited sources.
Title check ✅ Passed The title clearly and accurately summarizes the main change: replacing the obsolete mintlify CLI commands with the mint CLI across documentation files.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
📝 Coding Plan for PR comments
  • Generate coding plan

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
README.md (1)

5-17: ⚠️ Potential issue | 🟡 Minor

Add the Node.js prerequisite to the README setup section.

The installation step npm i -g mint requires Node.js v20.17.0+ (LTS recommended), but this is not documented. Contributors with older Node versions will encounter setup failures when following these instructions. Include the Node.js version requirement before the npm installation command.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@README.md` around lines 5 - 17, Add a Node.js prerequisite line above the
Mintlify install step in the README's Development section: state that Node.js
v20.17.0+ (LTS recommended) is required before running `npm i -g mint`, so
update the text near the existing `npm i -g mint` and `mint dev` commands to
include this Node.js version requirement.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@CLAUDE.md`:
- Around line 25-26: The troubleshooting step header "Re-install dependencies if
issues occur" is misleading because the command `rm -rf ~/.mintlify && mint dev`
clears the Mintlify CLI local cache, not project dependencies; update the
heading in CLAUDE.md to something like "Clear Mintlify local cache/state if
local preview errors" (or similar phrasing) and keep the existing command and
explanatory text unchanged so readers understand this clears Mintlify's local
state rather than reinstalling project dependencies.

In `@README.md`:
- Around line 15-17: The fenced code block containing the command "mint dev" is
missing a language tag; update the opening triple-backtick for that block to
specify the language (e.g., change ``` to ```bash) so the block reads ```bash
and the "mint dev" snippet is properly linted and highlighted.

---

Outside diff comments:
In `@README.md`:
- Around line 5-17: Add a Node.js prerequisite line above the Mintlify install
step in the README's Development section: state that Node.js v20.17.0+ (LTS
recommended) is required before running `npm i -g mint`, so update the text near
the existing `npm i -g mint` and `mint dev` commands to include this Node.js
version requirement.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 567754b3-7aca-4ce9-9811-fa74babb2392

📥 Commits

Reviewing files that changed from the base of the PR and between e923ff1 and 0ab63b5.

📒 Files selected for processing (2)
  • CLAUDE.md
  • README.md

@dimitristrechas dimitristrechas changed the title Replace mintlify CLI commands with mint Replace obsolete mintlify CLI commands with mint Mar 12, 2026
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.

1 participant