Improvements in documentation

[jabrena]

Summary by CodeRabbit

• Documentation
  • Added a “How to Use” guide detailing IDE chat and CLI workflows for applying system prompts, with step-by-step examples and screenshots.
  • Updated the main README with refined terminology (“Cursor rules” as system prompts), reorganized guidance on compatibility, and an overview of prompt structure; linked to the new usage guide and included visuals.
  • Clarified wording in a Java rules prompt for improved clarity.
  • Expanded generator documentation with a recommended system prompt structure and references to major LLM providers.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

Documentation-only update: minor text tweak in CURSOR-RULES-JAVA.md, substantial restructuring and terminology updates in README.md, addition of a new HOW-TO-USE.md usage guide with references to images, and a new subsection in generator/README.md describing system prompt structure. No code or API changes.

Changes

Cohort / File(s)	Change Summary
Cursor rules doc tweak CURSOR-RULES-JAVA.md	Updated the Interactive User Prompt text in the 112-java-maven-plugins row to remove “Can you.” No other fields changed.
Usage guide (System prompt) HOW-TO-USE.md	New guide explaining how to use a System prompt with Cursor via IDE chat and Cursor CLI, includes example prompt and references to screenshots.
Repository README restructure README.md	Renamed/expanded sections, shifted terminology to “Cursor rules” as system prompts, added coverage areas, reorganized getting-started and usage content, inserted prompts diagram placeholder, grammar refinements, and ADR wording adjustments.
Generator docs update generator/README.md	Added a subsection detailing recommended System prompt structure; references pml.xsd and major model providers.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

• Initial works with JMH support (Maven projects without modules) #253 — Also edits CURSOR-RULES-JAVA.md around rule 112, adding JMH-related rows and referencing the same rule.

Poem

A rabbit taps the README drum,
New paths for prompts now softly hum.
A nudge in CURSOR rules so slight,
A how-to lantern for the night.
Docs burrow deep, yet smooth to use—
Hop, click, prompt: no code to lose. 🐇✨

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

💡 Knowledge Base configuration:

• MCP integration is disabled by default for public repositories
• Jira integration is disabled by default for public repositories
• Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 8a8edfa and ecf5eae.

⛔ Files ignored due to path filters (6)

• docs/cursor-chat1.png is excluded by !**/*.png
• docs/cursor-chat2.png is excluded by !**/*.png
• docs/cursor-cli1.png is excluded by !**/*.png
• docs/cursor-cli2.png is excluded by !**/*.png
• docs/cursor-cli3.png is excluded by !**/*.png
• docs/prompts.png is excluded by !**/*.png

📒 Files selected for processing (4)

• CURSOR-RULES-JAVA.md (1 hunks)
• HOW-TO-USE.md (1 hunks)
• README.md (2 hunks)
• generator/README.md (1 hunks)

✨ Finishing Touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch feature/readme-update-082025

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Status, Documentation and Community

• Visit our Status Page to check the current availability of CodeRabbit.
• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.