Documentation (.cursorrules)

Yes, that is the feature request.
Lets start with Documentation of features that extends further than the Rules for AI section.

Attempting to search the rest of the web for what to actually include here I have come across things like.

files named

  • .cursor_rules
  • .cursorrule
  • .cursorrule.js that is supposed to be exclusively for when writing JavaScript. This article even suggest using YAML

Different opinions regarding Json vs Markdown

Due to the lack of actual documentation it is hard to figure out what is AI generated nonsense, and what is actually good advice.

1 Like

I agree. There should be better official documentation explaining how to leverage this feature best. I have been using Cursor to create a cursorrules.md file based on telling it what I wanted and having it summarize several sessions for areas it struggled with and how we worked to get what I wanted. I then would copy the contents of the markdown file and paste into .cursorrules. After reading about the json option, I asked Cursor to review my rules and suggest improvements including a determination if it understood json better than markdown. It claimed that it did and proposed a JSON version. I am now trying the JSON version of the file and hope to see improvement. However, this is still a shot in the dark, guessing and assuming what will work best. It seems that the team who is developing Cursor should have a clearer idea of what the correct format, structure, and contents should be for optimal results.

We are hoping to upgrade our documentation soon to include more details on the more advanced usage with these features.

To clarify, the only file that works as described above is .cursorrules, no other file will be automatically added as context to your AI queries!

1 Like

i wrote something similar yesterday - have to agree it is very confusing:

Definitive Rules - Discussion - Cursor - Community Forum