Skip to content

fix: rename artifactId from java-packageable-base, docs cleanup - #40

Merged
luxsolari merged 1 commit into
developfrom
docs-and-artifact-review
Jul 2, 2026
Merged

fix: rename artifactId from java-packageable-base, docs cleanup#40
luxsolari merged 1 commit into
developfrom
docs-and-artifact-review

Conversation

@luxsolari

Copy link
Copy Markdown
Owner

Summary

Fresh-eyes review, same process applied to sage-instructor, three-axes-framework, lux-solari-plugins, and claude-trip-computer.

pom.xml's artifactId was still literally java-packageable-base -- the name of a different template repo this one was bootstrapped from -- referenced consistently (if consistently wrong) across pom.xml, README.md, CLAUDE.md, docs/DEVELOPER_GUIDE.md, and .github/copilot-instructions.md. Renamed to console-jack everywhere. The packaging profiles (windows/mac/linux) all reference ${project.build.finalName}, so this is a safe, single-point change.

Also fixed:

  • <repository-url> placeholder never filled in.
  • Root README linked to a nonexistent docs/CLAUDE.md -- pointed to docs/README.md's index instead.
  • docs/README.md's own doc index was missing 5 of 13 files in that folder.
  • Added a license badge.

GitHub topics added separately.

Test plan

  • pom.xml validated as well-formed XML
  • CI (maven.yml) will build the project on this PR since it triggers on develop
  • Confirmed no other references to java-packageable-base remain anywhere in the repo

🤖 Generated with Claude Code

Fresh-eyes review, same process applied to sage-instructor,
three-axes-framework, lux-solari-plugins, and claude-trip-computer.

pom.xml's artifactId was still literally "java-packageable-base" --
the name of a different template repo this one was bootstrapped
from -- referenced consistently (if consistently wrong) across
pom.xml, README.md, CLAUDE.md, docs/DEVELOPER_GUIDE.md, and
.github/copilot-instructions.md. Renamed to "console-jack" everywhere.
The packaging profiles (windows/mac/linux) all reference
${project.build.finalName}, so this was a safe, single-point change
that propagates correctly to the jpackage build outputs.

Also fixed:
- <repository-url> placeholder never filled in, in README's clone
  instructions.
- Root README linked to a nonexistent docs/CLAUDE.md -- CLAUDE.md
  lives at repo root; pointed to docs/README.md's index instead,
  which already links it correctly.
- docs/README.md's own documentation index was missing 5 of the 13
  files actually in that folder (AUDIO_SYSTEM_GUIDE, ECS_GUIDE,
  INPUT_SYSTEM_GUIDE, RENDERING_GUIDE, STATE_MACHINE_GUIDE) -- added
  over time, never indexed.
- Added a license badge to README.

GitHub topics added separately for discoverability.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@claude

claude Bot commented Jul 2, 2026

Copy link
Copy Markdown

Review

This PR is a low-risk, mechanical cleanup: renaming the Maven artifactId from the leftover template name java-packageable-base to console-jack, plus a handful of docs fixes (README doc-index link, license badge, doc index gaps, and a filled-in <repository-url> placeholder). I verified the substantive claims directly against the repo:

  • pom.xml's jpackage profiles (windows/mac/linux/default) all reference ${project.build.finalName} rather than a hardcoded artifact name, so the rename is indeed a safe, single-point change as described.
  • The 5 doc-index entries added to docs/README.md (ECS_GUIDE, RENDERING_GUIDE, INPUT_SYSTEM_GUIDE, AUDIO_SYSTEM_GUIDE, STATE_MACHINE_GUIDE) all correspond to real files in docs/, and after this PR every markdown file in docs/ is now linked from the index.
  • LICENSE exists and is MIT, matching the new badge.

Finding

docs/DEVELOPER_GUIDE.md:12 — leftover <repository-url> placeholder was missed.
The PR fixes the identical git clone <repository-url> placeholder in README.md (replacing it with the real GitHub URL), but docs/DEVELOPER_GUIDE.md has the exact same placeholder on line 12, in a file this PR already touches (for the jar-filename fix a few lines below). Since the PR's stated test plan says "Confirmed no other references to java-packageable-base remain anywhere in the repo," it's worth extending that same pass to <repository-url> — right now a developer following DEVELOPER_GUIDE.md's setup steps would hit a non-functional clone command.

Everything else in the diff looks correct and consistent with the PR description; no bugs, security, or performance concerns given this is a docs/build-config-only change.

🤖 Generated with Claude Code

@github-actions

github-actions Bot commented Jul 2, 2026

Copy link
Copy Markdown

Qodana Community for JVM

It seems all right 👌

No new problems were found according to the checks applied

💡 Qodana analysis was run in the pull request mode: only the changed files were checked
☁️ View the detailed Qodana report

Contact Qodana team

Contact us at qodana-support@jetbrains.com

@luxsolari
luxsolari merged commit 4035976 into develop Jul 2, 2026
4 checks passed
@luxsolari
luxsolari deleted the docs-and-artifact-review branch July 2, 2026 20:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant