Skip to content

Docs: README and repo hygiene (2026-09-25 audit) - #11

Merged
pietechsolution merged 1 commit into
mainfrom
docs/readme-audit-2026-09-25
Sep 25, 2026
Merged

pietechsolution merged 1 commit into
mainfrom
docs/readme-audit-2026-09-25

Conversation

@pietechsolution

Copy link
Copy Markdown
Contributor

Held for review. Please do not merge yet.

Changes

  • README first paragraph now says what this artifact is (Java client for the SeatLayer API), followed by a short company line. Every README em dash rewritten as plain punctuation.
  • RELEASE.md rewritten as a short, current guide. The old one still described autoPublish=false and a manual Portal publish, which no longer matches pom.xml. The new guide covers the tag-push flow, the required Actions secrets and the fact that Central versions are permanent.
  • pom.xml: comment only, an internal decision date removed.
  • release.yml: comments and one echo string only. The secret-manager project/config name is replaced with neutral wording. No workflow logic changed.

Checks

  • pom.xml parses as XML and release.yml parses as YAML. No code changes.

@pietechsolution
pietechsolution merged commit eb095b0 into main Sep 25, 2026
2 checks passed
@pietechsolution
pietechsolution deleted the docs/readme-audit-2026-09-25 branch September 25, 2026 08:22
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.

2 participants