Add initial commands for the Cursor editor #4528
Conversation
Reviewer's GuideAdds initial Cursor editor command templates and documents their presence in the repo for documentation contributors. Flow diagram for applying the new Cursor commands in the documentation workflowflowchart TD
A[Contributor reads README .cursor section] --> B[Explore .cursor/commands]
B --> C{Editing task type}
C -->|Need better abstract| D[Open module in Cursor]
D --> E[Run abstract command]
E --> F[Review and refine generated abstract]
F --> G[Save file]
C -->|Need to split web UI and CLI procedures| H[Open combined procedure file in Cursor]
H --> I[Run split-web-ui-cli command]
I --> J[Review generated web UI file]
I --> K[Review generated CLI file]
J --> L[Adjust IDs, headings, and abstracts if needed]
K --> L
L --> M[Include new files in parent file]
M --> N[Run docs checks and commit changes]
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
github-actions
bot
added
Needs tech review
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey there - I've reviewed your changes - here's some feedback:
- In README.md the new Cursor link uses AsciiDoc-style
link:...[]syntax, which won’t render correctly in Markdown; switch it to standard Markdown link syntax instead. - In
.cursor/commands/abstract.md, the last bullet’s parenthetical example is missing a closing parenthesis, so please fix the punctuation there.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- In README.md the new Cursor link uses AsciiDoc-style `link:...[]` syntax, which won’t render correctly in Markdown; switch it to standard Markdown link syntax instead.
- In `.cursor/commands/abstract.md`, the last bullet’s parenthetical example is missing a closing parenthesis, so please fix the punctuation there.
## Individual Comments
### Comment 1
<location> `.cursor/commands/abstract.md:6` </location>
<code_context>
+* Make the abstract one or two sentences long.
+* Do not use documentation self-referential language (for example: avoid "This procedure..." or "This module").
+* Use user-centric language (for example: "You can...") rather than product-centric language (for example: "This feature...").
+* Where appropriate, include an example use case (for example: the reason why and when a user might find the contents of the module useful.
</code_context>
<issue_to_address>
**issue (typo):** Close the parenthesis at the end of the sentence.
This bullet opens a parenthesis after "for example:" but never closes it; consider ending the sentence with "useful)." to balance it.
</issue_to_address>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
aneta-petrova
removed
Needs tech review
aneta-petrova
force-pushed
the
add-cursor-commands
branch
from
425de75 to
9db065c
Compare
aneta-petrova
force-pushed
the
add-cursor-commands
branch
from
9db065c to
e15526b
Compare
maximiliankolb
left a comment
maximiliankolb
left a comment
There was a problem hiding this comment.
I noticed that the two MD files in .cursor do not have a heading. Is that by design?
|
I suppose it is by design (I just didn't bother adding headings or anything special). Cursor commands are created in markdown but no special markup is needed for Cursor to execute the instructions. However, it might be useful to think through how we want to structure these team commands. A quick search for examples revealed https://github.com/hamzafer/cursor-commands/tree/main/.cursor/commands where each command follows a template with Overview etc. and that might be useful. So I will look into this a bit more. |
|
And a note to self: https://ezablocki.com/posts/cursor-slash-commands/ also includes useful examples that I want to read through when improving the commands in this PR. |
Lennonka
left a comment
Lennonka
left a comment
There was a problem hiding this comment.
I'm all for it if nobody minds.
Lennonka
left a comment
Lennonka
left a comment
There was a problem hiding this comment.
Proposing a couple of adjustments of the split command that I've tested and work for me.
Co-authored-by: Lena Ansorgová <[email protected]>
|
I added headings to the Markdown files with commands, to improve readability and for potential future use if generated from the .md sources. I'd like to propose merging the commands as they are now. I very much appreciate @Lennonka's suggestions with changes that worked for her -- that's for the command to split modules into web UI and CLI. I can confirm that the abstract command also works pretty well because I used it in #4527 and the generated abstracts largely passed peer review without issues. However, I also filed #4553 to investigate potential for future improvements, although changes like this should IMO be thoroughly tested (to see if the AI-generated results pass peer review). |
Lennonka
left a comment
Lennonka
left a comment
There was a problem hiding this comment.
I'm cool with merging it as it is. We can improve as we go.
4 participants
What changes are you introducing?
Adding Cursor commands for use in the project.
Why are you introducing these changes? (Explanation, links to references, issues, etc.)
I find them useful and it's good to share.
Anything else to add? (Considerations, potential downsides, alternative solutions you have explored, etc.)
If there are concerns about adding these commands directly to the repo, I'm fine with closing the PR, in which case I'll just continue using them as my own personal global commands. Which means that they don't necessarily need to be included in the repo for anyone to use them.
Contributor checklists
Please cherry-pick my commits into:
Summary by Sourcery
Add shared Cursor editor command definitions for documentation contributors and document their usage in the repository README.
Enhancements:
.cursordirectory and its purpose in the project README.