chore(cursor): overhaul .cursor config and add public docs #4412
Conversation
- Updated `.cursor/README.md` to include a detailed directory structure and notes on organization by skills, commands, and agents. - Improved `.cursor/commands/*.md` files by adding related resources sections for better navigation and context. - Enhanced `.cursor/rules/*.md` files with references to external documentation and related rules, skills, and commands for comprehensive guidance. - Ensured all documentation adheres to the new standards for clarity and accessibility. This update aims to improve the discoverability and usability of the Cursor configuration resources.
- Included "Cursor" in the documentation structure under "Core Development" in `docs.json`. - Added a new entry for "Cursor Configuration" in `INDEX.md`, detailing its role in configuring rules, skills, and agents.
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This PR is a major overhaul of the .cursor configuration, introducing a new skills-based organization and adding extensive documentation for both internal agent use and public-facing contributor guidance. The changes are well-structured and significantly improve the discoverability and usability of the AI tooling resources.
My review found one high-severity issue related to an inconsistency in the Python code formatting command between a new hook script and the updated command documentation. This could lead to inconsistent formatting and should be addressed to ensure a consistent developer experience.
| if [[ "$FILE_PATH" == backend/* ]]; then | ||
| if command -v black &> /dev/null; then | ||
| echo "Formatting Python: $FILE_PATH" | ||
| black --line-length 120 --skip-string-normalization "$FILE_PATH" 2>/dev/null || true |
There was a problem hiding this comment.
There's an inconsistency between the black command used in this hook and the updated documentation in .cursor/commands/format.md. This script uses black --line-length 120 --skip-string-normalization ..., but the command documentation was updated in this same PR to remove the --skip-string-normalization flag, noting that this setting is now configured in backend/pyproject.toml.
To ensure consistent formatting behavior whether triggered automatically by this hook or run manually via the command, the flag should be removed from this script as well. This will prevent potential formatting churn where different tools apply different rules.
| black --line-length 120 --skip-string-normalization "$FILE_PATH" 2>/dev/null || true | |
| black --line-length 120 "$FILE_PATH" 2>/dev/null || true |
|
lgtm @HKTITAN @kodjima33 bro, as far as I know you are a fan of Cursor, so feel free to take a look at this PR and send feedback afterward :) |
2 participants
Description
This PR improves the repo’s Cursor/agent setup by expanding and organizing the
.cursor/configuration (rules/skills/commands/agents/docs/hooks/MCP config), and adds public documentation explaining how contributors should use.cursor/alongside the maindocs/site.Why
.cursor/resources for contributors and AI toolingdocs/is user-facing source of truth;.cursor/is editor/agent configuration (and.cursor/docs/is internal)Changes
Cursor configuration overhaul
.cursor/README.mdwith:.cursor/commands/,.cursor/agents/).cursor/:Public docs for
.cursor/docs/doc/developer/Cursor.mdxexplaining:.cursor/contains.cursor/differs fromdocs/docs/docs.json(nav entry)docs/INDEX.md(index entry)Related code
.cursor/README.md.cursor/mcp.json.cursor/hooks.jsondocs/doc/developer/Cursor.mdxdocs/docs.jsondocs/INDEX.mdAssumptions
Breaking changes
None.
Commits included
6414ef478— Enhance documentation and structure in the Cursor configuration4f7b44143— Add Cursor documentation to index and JSON files