Implement cursor rules java issue 319 (#321)

* Checkpoint before follow-up message
Co-authored-by: bren <bren@juanantonio.info>
* Updating README.md
* Updating diverse documentation


---------

Co-authored-by: Cursor Agent <cursoragent@cursor.com>

Author: jabrena

.cursor/rules/100-java-cursor-rules-list.md

@@ -6,7 +6,7 @@ A collection of `System prompts` for Java Enterprise development.
 
 ### Repository Layout
 
-- `./cursor/rules`: a collection of `System prompts` for Java Enterprise development. The main outcome of this project.
+- `.cursor/rules`: a collection of `System prompts` for Java Enterprise development. The main outcome of this project.
 - `system-prompts-generator`: a Java project designed to build the System prompts based on XML documents.
 - `examples`: a collection of Java examples designed to test with the different System prompts.
 - `site-generator`: JBake project designed to autogenerate public site in `docs` folder
@@ -29,15 +29,15 @@ Run the tests:
 ./mvnw clean verify -pl system-prompts-generator
 ```
 
-If the tests passes, you could promote the changes to `./cursor/rules`:
+If the tests passes, you could promote the changes to `.cursor/rules`:
 
 ```bash
 ./mvnw clean install -pl system-prompts-generator
 ```
 
 ## General Guidance
 
-- Don´t update any file from the path `./cursor/rules`, find the XML file in the path `generator/src/main/resources`.
+- Don´t update any file from the path `.cursor/rules`, find the XML file in the path `generator/src/main/resources`.
 - The project is based on Java 24.
 
 ## Commit Messages and Pull Requests

.cursor/rules/170-java-documentation.md

@@ -10,7 +10,7 @@ If you have the idea to contribute, review the whole process in detail:
 ```bash
 cd generator
 ./mvnw clean verify # Pass tests
-./mvnw clean install # Pass tests & copy new .md files into ./cursor/rules (The way to promote changes)
+./mvnw clean install # Pass tests & copy new .md files into .cursor/rules (The way to promote changes)
 ```
 
 When you feel confident with the process, fork the repository and try to create new XML documents. Models will help you because an XML file is more rigid than natural language and it has `a common vocabulary` to create prompts.

.cursor/rules/171-java-diagrams.md

@@ -65,11 +65,13 @@ Use the following collection of System prompts of Java to improve your Java deve
 | - | Code Refactoring from suggestions from analysis | `Can you apply the solutions from @profiling-solutions-yyyymmdd.md in @/info to mitigate bottlenecks` | Make a refactoring with the notes from the analysis |
 | [164-java-profiling-compare](.cursor/rules/164-java-profiling-compare.md) | Compare results comparing results before and after applying changes in the code | **Prompt:** `Review if the problems was solved with last refactoring using the reports located in @/results with the cursor rule 154-java-profiling-compare` **Note:**  Put in the context the folder with the results | This cursor rule is applied automatically without any interaction with the Software engineer. |
 
-## Documentation rule
+## Documentation rules
 
 | Activity | Description | Prompt | Notes |
 |----|----|-----|----|
-| [170-java-documentation](.cursor/rules/170-java-documentation.md) | Generate Java project documentation & diagrams including README.md and package-info.java files using a modular step-based approach | **Interactive User Prompt:** `Generate technical documentation & diagrams about the project with the cursor rule @170-java-documentation` **User Prompt:** `Create a UML class diagram with @170-java-documentation without any question` (Example) **Note:** Add in the context the folder to generate the documentation. The rule will analyze existing documentation and ask for user preferences before generating anything. Ensures project validation with Maven before proceeding. | It is possible to apply the System prompt in an interactive and non interactive way. If you are thinking to create Diagrams, I recommend to run the Jbang tool `jbang puml-to-png@jabrena --watch .` in order to generate on fly the diagrams in png format |
+| [170-java-documentation](.cursor/rules/170-java-documentation.md) | Generate Java project documentation including README.md, package-info.java files, and Javadoc using a modular step-based approach | **Interactive User Prompt:** `Generate technical documentation about the project with the cursor rule @170-java-documentation` **User Prompt:** `Generate README.md with @170-java-documentation without any question` (Example) **Note:** Add in the context the folder to generate the documentation. The rule will analyze existing documentation and ask for user preferences before generating anything. Ensures project validation with Maven before proceeding. | Focused on documentation generation only. For diagrams, use @171-java-diagrams |
+| [171-java-diagrams](.cursor/rules/171-java-diagrams.md) | Generate Java project diagrams including UML sequence, class, state-machine diagrams and C4 model diagrams using a modular step-based approach | **Interactive User Prompt:** `Generate diagrams about the project with the cursor rule @171-java-diagrams` **User Prompt:** `Create UML class diagrams with @171-java-diagrams without any question` (Example) **Note:** Add in the context the folder to generate the diagrams. The rule will analyze the codebase and ask for user preferences before generating anything. Ensures project validation with Maven before proceeding. | Focused on diagram generation only. I recommend to run the JBang tool `jbang puml-to-png@jabrena --watch .` in order to generate diagrams in PNG format on the fly |
+
 
 ---
 

AGENTS.md

@@ -10,25 +10,25 @@ This view has a big green button with the text: `<> Code`. If you click on it, y
 
 ![](./documentation/getting-started-github.png)
 
-Once you have downloaded it, go to the `Downloads` folder in your system and you should see the zip file: `cursor-rules-java-main.zip`. Unzip it and copy the folder `./cursor` into the Java repository where you want to use these Cursor rules.
+Once you have downloaded it, go to the `Downloads` folder in your system and you should see the zip file: `cursor-rules-java-main.zip`. Unzip it and copy the folder `.cursor` into the Java repository where you want to use these Cursor rules.
 
 **Note:** ⚠️ Using this approach, you are using the main branch which is not released yet.
 
 ### Using the latest tagged zipped rules
 
-Downloading the zipped release is the safest approach if you are interested in using the latest well-tested release. Go to [the latest release](https://github.com/jabrena/cursor-rules-java/releases) and download the zip assets included in the latest release. As in the previous case, download the zip, unzip it and copy the folder `./cursor` into the Java repository where you want to use these Cursor rules.
+Downloading the zipped release is the safest approach if you are interested in using the latest well-tested release. Go to [the latest release](https://github.com/jabrena/cursor-rules-java/releases) and download the zip assets included in the latest release. As in the previous case, download the zip, unzip it and copy the folder `.cursor` into the Java repository where you want to use these Cursor rules.
 
 ### Using a JBang CLI program specialized in this task
 
 **JBang** is a tool that lets you run Java code as scripts without the need for traditional project setup, compilation, or build tools - just write Java and run it directly.
 
-Using JBang, you can delegate the action to put the `./cursor/rules` from this repository into the Java repository where you want to use these Cursor rules.
+Using JBang, you can delegate the action to put the `.cursor/rules` from this repository into the Java repository where you want to use these Cursor rules.
 
 Execute the following commands to use it:
 
 ```bash
 sdk install jbang
-# Add cursor rules for Java in ./cursor/rules
+# Add cursor rules for Java in .cursor/rules
 jbang --fresh setup@jabrena init --cursor https://github.com/jabrena/cursor-rules-java
 ```
 
@@ -38,7 +38,7 @@ jbang --fresh setup@jabrena init --cursor https://github.com/jabrena/cursor-rule
 |-------------|-------------|--------|-------|
 | [100-java-cursor-rules-list](.cursor/rules/100-java-cursor-rules-list.md) | Create a comprehensive step-by-step guide for using cursor rules for Java | `Create a Java development guide using the cursor rule @100-java-cursor-rules-list` | This cursor rule is applied automatically without any interaction with the software engineer. |
 
-Once you have installed the cursor rules in the path `./cursor/rules`, type the following prompt in the cursor chat:
+Once you have installed the cursor rules in the path `.cursor/rules`, type the following prompt in the cursor chat:
 
 ![](./documentation/getting-started-prompt.png)
 

CONTRIBUTING.md

@@ -1,6 +1,6 @@
 # Developer notes
 
-```
+```bash
 ./mvnw clean verify
 ./mvnw clean verify -pl system-prompts-generator
 ./mvnw clean install -pl system-prompts-generator