Clarify Mint Format Instructions - #7234
Open
mintlify[bot] wants to merge 2 commits into
Open
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! |
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 security impact.Overview
Updates the CLI commands reference page with two small documentation tweaks.
The frontmatter
keywordsfield is reformatted from a single-line array to a standard YAML list; the listed terms are unchanged.The
mint formatwarning now adds workflow guidance: because formatting can produce large diffs, readers are told to merge or finish important pending branches first, then runmint formaton a new branch so the reformat is easier to review.Reviewed by Cursor Bugbot for commit e568672. Bugbot is set up for automated code reviews on this repo. Configure here.
Mintlify
0 threads from 0 users in Mintlify