Skip to content

Conversation

@lawreka
Copy link
Contributor

@lawreka lawreka commented Jun 13, 2025

Documentation changes

This PR removes the difference between CLI and client in our docs, since customers don't know/care that we package the client in the CLI under the hood. Running mint update updates both. It also moves the troubleshooting command to re-install the CLI at the latest version locally up the page with the code group that has npm/yarn/pnpm versions of the command.


For Reviewers

When reviewing documentation PRs, please consider:

✅ Technical accuracy

  • Code examples work as written
  • Commands and configurations are correct
  • Links resolve to the right destinations
  • Prerequisites and requirements are accurate

✅ Clarity and completeness

  • Instructions are clear and easy to follow
  • Steps are in logical order
  • Nothing important is missing
  • Examples help illustrate the concepts

✅ User experience

  • A new user could follow these docs successfully
  • Common gotchas or edge cases are addressed
  • Error messages or troubleshooting guidance is helpful

Copy link
Collaborator

@ethanpalm ethanpalm left a comment

Choose a reason for hiding this comment

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

:shipit:

@lawreka lawreka merged commit 3f86ce4 into main Jun 13, 2025
4 checks passed
@lawreka lawreka deleted the kathryn/mint-update-docs-2 branch June 13, 2025 16:59
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