Clarify Mint Format Instructions - #7234
Merged
Merged
Conversation
- Updated cli/commands.mdx Mintlify-Source: dashboard-editor
- Updated cli/commands.mdx Mintlify-Source: dashboard-editor
Contributor
|
Recently make improvements to mint format, and would like to give more companies knowledge about it. However, it is a pretty scary command to run, so wanted to clarify that it can cause merge conflicts, and is a big diff, so make sure to make and resolve branches. Please let me know if u have better thoughts on how to fix this! |
ethanpalm
approved these changes
Sep 11, 2026
ethanpalm
left a comment
Collaborator
There was a problem hiding this comment.
I split it into a warning and a tip so the suggestion stands out more on it's own. lgtm!
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Note
Low Risk
Documentation-only edits to
cli/commands.mdxwith no runtime or API impact.Overview
Updates the CLI Commands reference to make
mint formatsafer and clearer to adopt.The in-place rewrite Warning now appears immediately under the
mint formatheading (before the command description). A new Tip recommends resolving open branches first and runningmint formaton a dedicated formatting branch to limit merge conflicts and unrelated churn.Frontmatter
keywordsis converted from a one-line array to a YAML list for consistency with typical Mintlify frontmatter style.Reviewed by Cursor Bugbot for commit 74949d6. Bugbot is set up for automated code reviews on this repo. Configure here.
Mintlify
0 threads from 0 users in Mintlify