Skip to content

Commit 773222e

Browse files
authored
Adding new content (#469)
* Adding new content * Improving site support * New improvements * New progress
1 parent 6e62e44 commit 773222e

18 files changed

Lines changed: 668 additions & 140 deletions

File tree

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,4 @@ target/
55
.classpath
66
.claude
77
dependency-reduced-pom.xml
8+
docs-local/

AGENTS.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,14 +38,15 @@ You are an expert Java developer and technical writer for this project.
3838
# Regenerate the website into docs/
3939
./mvnw clean generate-resources -pl site-generator -P site-update
4040

41+
# Serve the website locally (mirrors GitHub Pages path: http://localhost:8820/)
42+
./mvnw clean generate-resources jbake:inline -pl site-generator -P local-preview
43+
4144
# Regenerate agent skills into skills/
4245
./mvnw clean install -pl skills-generator
4346

4447
# Validate agent skills
4548
npx skill-check skills
4649

47-
# Serve the website locally
48-
jwebserver -p 8000 -d "$(pwd)/docs"
4950
```
5051

5152
## Git workflow

DEVELOPER.md

Lines changed: 86 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,10 @@
3737
jwebserver -p 8005 -d "$(pwd)/target/site/"
3838

3939
# Run blog in local
40-
jwebserver -p 8005 -d "$(pwd)/docs/"
40+
./mvnw clean generate-resources jbake:inline -pl site-generator -P local-preview
41+
42+
# Promote blog changes to Prod
43+
./mvnw clean generate-resources -pl site-generator -P site-update
4144
```
4245

4346
## Plugin Goals Reference
@@ -46,104 +49,132 @@ The following sections list useful goals for each plugin configured in this proj
4649

4750
### maven-enforcer-plugin
4851

49-
| Goal | Description |
50-
|------|-------------|
51-
| `./mvnw enforcer:enforce` | Execute enforcer rules |
52+
53+
| Goal | Description |
54+
| ------------------------------ | ------------------------------------ |
55+
| `./mvnw enforcer:enforce` | Execute enforcer rules |
5256
| `./mvnw enforcer:display-info` | Display current platform information |
5357

58+
5459
### spotless-maven-plugin
5560

56-
| Goal | Description |
57-
|------|-------------|
58-
| `./mvnw spotless:apply` | Apply formatting fixes |
61+
62+
| Goal | Description |
63+
| ----------------------- | --------------------------------------- |
64+
| `./mvnw spotless:apply` | Apply formatting fixes |
5965
| `./mvnw spotless:check` | Check formatting and fail on violations |
6066

67+
6168
### versions-maven-plugin
6269

63-
| Goal | Description |
64-
|------|-------------|
65-
| `./mvnw versions:display-dependency-updates` | Show available dependency updates |
66-
| `./mvnw versions:display-plugin-updates` | Show available plugin updates |
67-
| `./mvnw versions:display-property-updates` | Show available property updates |
68-
| `./mvnw versions:use-latest-releases` | Update dependencies to latest releases |
69-
| `./mvnw versions:set -DnewVersion=X.Y.Z` | Set the project version |
70+
71+
| Goal | Description |
72+
| -------------------------------------------- | -------------------------------------- |
73+
| `./mvnw versions:display-dependency-updates` | Show available dependency updates |
74+
| `./mvnw versions:display-plugin-updates` | Show available plugin updates |
75+
| `./mvnw versions:display-property-updates` | Show available property updates |
76+
| `./mvnw versions:use-latest-releases` | Update dependencies to latest releases |
77+
| `./mvnw versions:set -DnewVersion=X.Y.Z` | Set the project version |
78+
7079

7180
### spotbugs-maven-plugin
7281

73-
| Goal | Description |
74-
|------|-------------|
75-
| `./mvnw spotbugs:check` | Run SpotBugs analysis and fail on bugs |
76-
| `./mvnw spotbugs:spotbugs` | Generate a SpotBugs report |
77-
| `./mvnw spotbugs:gui` | Launch the SpotBugs GUI |
82+
83+
| Goal | Description |
84+
| -------------------------- | -------------------------------------- |
85+
| `./mvnw spotbugs:check` | Run SpotBugs analysis and fail on bugs |
86+
| `./mvnw spotbugs:spotbugs` | Generate a SpotBugs report |
87+
| `./mvnw spotbugs:gui` | Launch the SpotBugs GUI |
88+
7889

7990
### maven-pmd-plugin
8091

81-
| Goal | Description |
82-
|------|-------------|
83-
| `./mvnw pmd:check` | Run PMD analysis and fail on violations |
84-
| `./mvnw pmd:pmd` | Generate a PMD report |
92+
93+
| Goal | Description |
94+
| ---------------------- | ----------------------------------------------- |
95+
| `./mvnw pmd:check` | Run PMD analysis and fail on violations |
96+
| `./mvnw pmd:pmd` | Generate a PMD report |
8597
| `./mvnw pmd:cpd-check` | Run copy-paste detection and fail on duplicates |
8698

99+
87100
### dependency-check-maven
88101

89-
| Goal | Description |
90-
|------|-------------|
91-
| `./mvnw dependency-check:check` | Run OWASP dependency check and fail on CVSS threshold |
92-
| `./mvnw dependency-check:aggregate` | Aggregate vulnerability report for multi-module projects |
93-
| `./mvnw dependency-check:update-only` | Update the local NVD database only |
94-
| `./mvnw dependency-check:purge` | Delete the local NVD database cache |
102+
103+
| Goal | Description |
104+
| ------------------------------------- | -------------------------------------------------------- |
105+
| `./mvnw dependency-check:check` | Run OWASP dependency check and fail on CVSS threshold |
106+
| `./mvnw dependency-check:aggregate` | Aggregate vulnerability report for multi-module projects |
107+
| `./mvnw dependency-check:update-only` | Update the local NVD database only |
108+
| `./mvnw dependency-check:purge` | Delete the local NVD database cache |
109+
95110

96111
### maven-compiler-plugin
97112

98-
| Goal | Description |
99-
|------|-------------|
100-
| `./mvnw compiler:compile` | Compile main source files |
113+
114+
| Goal | Description |
115+
| ----------------------------- | ------------------------- |
116+
| `./mvnw compiler:compile` | Compile main source files |
101117
| `./mvnw compiler:testCompile` | Compile test source files |
102118

119+
103120
### maven-surefire-plugin
104121

105-
| Goal | Description |
106-
|------|-------------|
107-
| `./mvnw surefire:test` | Run unit tests |
122+
123+
| Goal | Description |
124+
| ---------------------- | ------------------------ |
125+
| `./mvnw surefire:test` | Run unit tests |
108126
| `./mvnw surefire:help` | Display help information |
109127

128+
110129
### maven-resources-plugin
111130

112-
| Goal | Description |
113-
|------|-------------|
114-
| `./mvnw resources:resources` | Copy main resources to output directory |
131+
132+
| Goal | Description |
133+
| -------------------------------- | --------------------------------------- |
134+
| `./mvnw resources:resources` | Copy main resources to output directory |
115135
| `./mvnw resources:testResources` | Copy test resources to output directory |
116136

137+
117138
### maven-clean-plugin
118139

119-
| Goal | Description |
120-
|------|-------------|
140+
141+
| Goal | Description |
142+
| -------------------- | --------------------------------- |
121143
| `./mvnw clean:clean` | Delete the build output directory |
122144

145+
123146
### jbake-maven-plugin
124147

125-
| Goal | Description |
126-
|------|-------------|
127-
| `./mvnw jbake:generate` | Generate the static site with JBake |
128-
| `./mvnw jbake:inline` | Generate and serve the site with a built-in server |
129-
| `./mvnw jbake:watch` | Watch for source changes and regenerate automatically |
148+
149+
| Goal | Description |
150+
| ----------------------- | ----------------------------------------------------- |
151+
| `./mvnw jbake:generate` | Generate the static site with JBake |
152+
| `./mvnw jbake:inline` | Generate and serve the site with a built-in server |
153+
| `./mvnw jbake:watch` | Watch for source changes and regenerate automatically |
154+
130155

131156
## Maven Profiles
132157

133158
The following profiles are declared in this project. Activate them with `-P <profileId>`.
134159

135-
| Profile ID | Command | Activation | Description |
136-
|------------|---------|------------|-------------|
137-
| `security` | `./mvnw clean verify -P security` | manual | Runs OWASP Dependency-Check against all scopes and fails the build on any vulnerability with a CVSS score ≥ 7. |
138-
| `find-bugs` | `./mvnw clean verify -P find-bugs` | manual | Runs SpotBugs (Max effort, Low threshold) and PMD static analysis, failing the build on any detected issue. |
139-
| `site-update` | `./mvnw clean generate-resources -pl site-generator -P site-update` | manual | Cleans the `docs/` folder, generates the GitHub Pages static site with JBake, and copies conference assets into `docs/`. |
160+
161+
| Profile ID | Command | Activation | Description |
162+
| ---------------- | ----------------------------------------------------------------------- | ---------- | ------------------------------------------------------------------------------------------------------------------------ |
163+
| `security` | `./mvnw clean verify -P security` | manual | Runs OWASP Dependency-Check against all scopes and fails the build on any vulnerability with a CVSS score ≥ 7. |
164+
| `find-bugs` | `./mvnw clean verify -P find-bugs` | manual | Runs SpotBugs (Max effort, Low threshold) and PMD static analysis, failing the build on any detected issue. |
165+
| `site-update` | `./mvnw clean generate-resources -pl site-generator -P site-update` | manual | Cleans the `docs/` folder, generates the GitHub Pages static site with JBake, and copies conference assets into `docs/`. |
166+
| `local-preview` | `./mvnw clean generate-resources jbake:inline -pl site-generator -P local-preview` | manual | Generates the site to `target/docs-local`, copies images, and serves at http://localhost:8820/ for local preview. |
167+
140168

141169
## Submodules
142170

143171
This is a multi-module project. The following modules are declared in the root `pom.xml`.
144172

145-
| Module | Artifact ID | Commands | Description |
146-
|--------|-------------|----------|-------------|
147-
| `system-prompts-generator` | `cursor-rules-java-generator` | `./mvnw clean verify -pl system-prompts-generator`<br>`./mvnw clean install -pl system-prompts-generator` | Transforms XML rule sources via XInclude and XSLT into Markdown cursor rules, then deploys them to `.cursor/rules/`. |
148-
| `skills-generator` | `cursor-rules-java-skills-generator` | `./mvnw clean verify -pl skills-generator`<br>`./mvnw clean install -pl skills-generator` | Generates agent skills from the cursor rules and deploys them to `skills/`. |
149-
| `site-generator` | `cursor-rules-java-site` | `./mvnw clean verify -pl site-generator`<br>`./mvnw clean generate-resources -pl site-generator -P site-update` | Generates the project's GitHub Pages static website using JBake and publishes output to `docs/`. |
173+
174+
| Module | Artifact ID | Commands | Description |
175+
| -------------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------- |
176+
| `system-prompts-generator` | `cursor-rules-java-generator` | `./mvnw clean verify -pl system-prompts-generator` `./mvnw clean install -pl system-prompts-generator` | Transforms XML rule sources via XInclude and XSLT into Markdown cursor rules, then deploys them to `.cursor/rules/`. |
177+
| `skills-generator` | `cursor-rules-java-skills-generator` | `./mvnw clean verify -pl skills-generator` `./mvnw clean install -pl skills-generator` | Generates agent skills from the cursor rules and deploys them to `skills/`. |
178+
| `site-generator` | `cursor-rules-java-site` | `./mvnw clean verify -pl site-generator` | Generates the project's GitHub Pages static website using JBake. Use the `site-update` profile to publish to `docs/`. |
179+
180+

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222

2323
## Goal
2424

25-
The project provides a collection of `System prompts` & `Skills` for Java Enterprise development that help software engineers and pipelines in their daily programming work.
25+
The project provides a curated collection of `System prompts` & `Skills` for Java Enterprise development that help software engineers and pipelines in their daily programming work.
2626
The project covers aspects like `Build system based on Maven`, `Design`, `Coding`, `Testing`, `Refactoring & JMH Benchmarking`, `Performance testing with JMeter`, `Profiling with Async profiler/OpenJDK tools`, `Documentation`, `ADRs`, `Diagrams` & `AGENTS.md`.
2727

2828
## Deliverables
@@ -134,13 +134,15 @@ Java uses JEPs as the vehicle to describe new features to be added to the langua
134134
- https://agentskills.io/home
135135
- https://github.com/anthropics/skills
136136
- https://skills.sh/
137+
- https://github.com/vercel-labs/skills/issues
137138
- https://skillsmp.com/
138139
- https://cursor.com/docs/cli/github-actions
139140
- https://code.claude.com/docs/en/github-actions
140141
- [https://www.anthropic.com/claude-code](https://www.anthropic.com/claude-code)
141142
- [https://github.com/features/copilot](https://github.com/features/copilot)
142143
- [https://www.jetbrains.com/junie/](https://www.jetbrains.com/junie/)
143144
- [https://openjdk.org/jeps/0](https://openjdk.org/jeps/0)
145+
- https://jbake.org/docs/latest/
144146

145147
## Cursor rules ecosystem
146148

docs/2/index.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@
7878
<div class="page-heading">
7979
<h1>Cursor rules and Skills for Java</h1>
8080
<hr class="small">
81-
<span class="page-subheading">A collection of System prompts and Skills for Java Enterprise development that help software engineers in their daily programming work & pipelines.</span>
81+
<span class="page-subheading">A curated collection of System prompts and Skills for Java Enterprise development that help software engineers in their daily programming work & pipelines.</span>
8282
</div>
8383
</div>
8484
</div>
@@ -93,7 +93,7 @@ <h1>Cursor rules and Skills for Java</h1>
9393
<div class="page-heading">
9494
<h1>Cursor rules and Skills for Java</h1>
9595
<hr class="small">
96-
<span class="page-subheading">A collection of System prompts and Skills for Java Enterprise development that help software engineers in their daily programming work & pipelines.</span>
96+
<span class="page-subheading">A curated collection of System prompts and Skills for Java Enterprise development that help software engineers in their daily programming work & pipelines.</span>
9797
</div>
9898
</div>
9999
</div>

0 commit comments

Comments
 (0)