Skip to content

docs: fix org-less issue links, rx3 artifact drift, dead badges, and stale demo paths - #340

Open
ZayanKhan-12 wants to merge 4 commits into
salesforce:masterfrom
ZayanKhan-12:docs/fix-links-badges-artifacts
Open

docs: fix org-less issue links, rx3 artifact drift, dead badges, and stale demo paths#340
ZayanKhan-12 wants to merge 4 commits into
salesforce:masterfrom
ZayanKhan-12:docs/fix-links-badges-artifacts

Conversation

@ZayanKhan-12

Copy link
Copy Markdown

Four commits, all documentation:

  1. CONTRIBUTING.md — the Issues links (github.com/reactive-grpc/issues) are missing the salesforce/ org segment and 404; the in-page anchors used #creating_a_pull_request, but GitHub slugs the "Creating a Pull Request" heading with hyphens.
  2. rx3 module READMEs — the RxJava 3 modules' docs still reference the RxJava 2 artifacts: dependency <artifactId>rxgrpc</artifactId>/rxgrpc-stub (published artifacts are rx3grpc/rx3grpc-stub), protoc plugin mainClass com.salesforce.rx3grpc.RxGrpcGenerator (the class is Rx3GrpcGenerator — the only generator in the module), and badges pointing at the rxgrpc artifacts.
  3. All module READMEsmaven-badges.herokuapp.com badge images return 404 since the Heroku free-tier shutdown; replaced with shields.io Maven Central badges (verified 200) linking to central.sonatype.com, keeping each module's own artifact id.
  4. Kotlin chat demo README — commands still use the pre-move demos/ReactorChat-Kotlin/... module paths; the demo lives at demos/reactive-grpc-chat/reactor-chat-kotlin/ReactorChat-{Server,Client}-Kt.

Verification: class/artifact names checked against the tree and Maven Central (rx3grpc/rx3grpc-stub badges resolve; old badge URLs curl 404); full mvn test passes locally (BUILD SUCCESS, 369 tests, 0 failures; JDK 21 toolchain, macOS arm64).

Prepared with AI assistance (Claude); every claim mechanically verified as described.

zk-khan and others added 4 commits July 26, 2026 20:01
github.com/reactive-grpc/issues is missing the salesforce org segment
and 404s; the in-page anchors used underscores, but GitHub slugs the
'Creating a Pull Request' heading with hyphens.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
The rx3grpc/rx3grpc-stub READMEs pointed badges, dependency
artifactIds, and the protoc plugin mainClass at the old rxgrpc
artifacts: the published artifacts are rx3grpc/rx3grpc-stub and the
generator class is com.salesforce.rx3grpc.Rx3GrpcGenerator (the only
generator in the module). Also replaces the maven-badges.herokuapp.com
badge images, which return 404 since the Heroku free tier shutdown,
with shields.io equivalents (verified 200).

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
maven-badges.herokuapp.com has returned 404 since the Heroku free-tier
shutdown, so every module README's Maven Central badge is broken. Use
shields.io badges (verified 200) linking to central.sonatype.com,
keeping each module's own artifact id.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
The demo moved to demos/reactive-grpc-chat/reactor-chat-kotlin/, so the
documented -pl module paths and jar path no longer exist.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@salesforce-cla

Copy link
Copy Markdown

Thanks for the contribution! Before we can merge this, we need @zk-khan to sign the Salesforce Inc. Contributor License Agreement.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants