Skip to content

Clarify Mint Format Instructions - #7234

Merged
ethanpalm merged 3 commits into
mainfrom
nivedh/draft-sep-2-2
Sep 11, 2026
Merged

Clarify Mint Format Instructions#7234
ethanpalm merged 3 commits into
mainfrom
nivedh/draft-sep-2-2

Conversation

@mintlify

@mintlify mintlify Bot commented Sep 3, 2026

Copy link
Copy Markdown
Contributor

Note

Low Risk
Documentation-only edits to cli/commands.mdx with no runtime or API impact.

Overview
Updates the CLI Commands reference to make mint format safer and clearer to adopt.

The in-place rewrite Warning now appears immediately under the mint format heading (before the command description). A new Tip recommends resolving open branches first and running mint format on a dedicated formatting branch to limit merge conflicts and unrelated churn.

Frontmatter keywords is 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

  • No unresolved comments

Review in Mintlify

mintlify Bot added 2 commits September 3, 2026 01:27
- Updated cli/commands.mdx

Mintlify-Source: dashboard-editor
- Updated cli/commands.mdx

Mintlify-Source: dashboard-editor
@N43527

N43527 commented Sep 3, 2026

Copy link
Copy Markdown
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!

@mintlify mintlify Bot changed the title Draft from Sep 2 (2) Clarify Mint Format Instructions Sep 3, 2026

@ethanpalm ethanpalm left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I split it into a warning and a tip so the suggestion stands out more on it's own. lgtm!

@ethanpalm
ethanpalm merged commit f7487cf into main Sep 11, 2026
3 checks passed
@ethanpalm
ethanpalm deleted the nivedh/draft-sep-2-2 branch September 11, 2026 17:39
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.

2 participants