Skip to content

Conversation

@ethanpalm
Copy link
Collaborator

@ethanpalm ethanpalm commented Jun 25, 2025

Documentation changes

This PR adds a cursor rule for people working locally in Cursor. We can refine it as we use it and evaluate results.

Part of https://linear.app/mintlify/issue/DOC-80/ai-tooling-for-docs


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 merged commit 83e9664 into main Jun 25, 2025
5 checks passed
@ethanpalm ethanpalm deleted the add-cursor-rule branch June 25, 2025 23:13
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