Skip to content

Conversation

@ethanpalm
Copy link
Collaborator

Documentation changes

This PR adds a guide on using Cursor to write your docs.

  • Overview of Cursor rules and using Cursor to write your docs with Mintlify components
  • Copyable example rule

Closes https://linear.app/mintlify/issue/DOC-38/cursor-guide


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
Contributor

@IHSten IHSten left a comment

Choose a reason for hiding this comment

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

One 💬 but otherwise this looks good and the preview looks good!

@ethanpalm ethanpalm merged commit 0495a5a into main Jun 4, 2025
4 checks passed
@ethanpalm ethanpalm deleted the cursor-guide branch June 4, 2025 20: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.

3 participants