Skip to content

Conversation

@ethanpalm
Copy link
Collaborator

Documentation changes

Brief description of what's being updated

Closes https://linear.app/mintlify/issue/DOC-70/assistant-enhancements


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

@ethanpalm ethanpalm marked this pull request as ready for review June 20, 2025 17:23
The assistant is automatically enabled for accounts on Pro, Growth, and Enterprise plans. See [Pricing](https://mintlify.com/pricing) for details.
You can monitor assistant usage through your dashboard to understand user behavior and documentation effectiveness. Query data and interaction patterns can help identify:

* Frequently asked questions that might need better coverage.
Copy link

Choose a reason for hiding this comment

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

we haven't shipped analytics yet, so the only interaction patterns we have atm is just a raw list of conversations: this is changing soon though!!

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Gotcha. I think this is worth including now since people can export the data and do their own analysis, which is still valuable. I'll push an edit to make it clear that this is achieved through your own analysis and not in the dashboard.

Copy link

@a-lchen a-lchen left a comment

Choose a reason for hiding this comment

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

lgtm!

@ethanpalm ethanpalm merged commit 4b5adf1 into main Jun 23, 2025
4 checks passed
@ethanpalm ethanpalm deleted the assistant-update branch June 23, 2025 17:02
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