Skip to content

doc: Add rust apollo client link#5514

Merged
nobodyiam merged 2 commits intoapolloconfig:masterfrom
jmjoy:doc
Dec 13, 2025
Merged

doc: Add rust apollo client link#5514
nobodyiam merged 2 commits intoapolloconfig:masterfrom
jmjoy:doc

Conversation

@jmjoy
Copy link
Contributor

@jmjoy jmjoy commented Dec 9, 2025

What's the purpose of this PR

This pull request updates the Rust client documentation to include a new Apollo Rust client implementation. Both the English and Chinese user guides now reference the apollo-client project by jmjoy.

Which issue(s) this PR fixes:

Fixes #

Brief changelog

doc: Add rust apollo client link

Follow this checklist to help us incorporate your contribution quickly and easily:

  • Read the Contributing Guide before making this pull request.
  • Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
  • Write necessary unit tests to verify the code.
  • Run mvn clean test to make sure this pull request doesn't break anything.
  • Run mvn spotless:apply to format your code.
  • Update the CHANGES log.

Summary by CodeRabbit

  • Documentation
    • Added Apollo Rust client 3 documentation section including project address and acknowledgments.
    • Documentation expanded to support both English and Chinese-speaking users.
    • Release notes updated with new entry referencing Rust client documentation resources.

✏️ Tip: You can customize this high-level summary in your review settings.

@github-actions
Copy link

github-actions bot commented Dec 9, 2025

CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Dec 9, 2025

Walkthrough

This PR adds documentation for Apollo Rust client 3 across multiple language editions. A changelog entry is added to CHANGES.md for Apollo 2.5.0, and new sections are appended to both English and Chinese SDK user guides referencing the project and providing attribution.

Changes

Cohort / File(s) Summary
Documentation Updates
CHANGES.md, docs/en/client/rust-sdks-user-guide.md, docs/zh/client/rust-sdks-user-guide.md
Added new documentation sections and changelog entry for Apollo Rust client 3, including project links and attribution notes in both English and Chinese documentation

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

  • Verify consistency of content across English and Chinese versions
  • Confirm all project links are valid and properly formatted

Possibly related PRs

Suggested labels

size:S, lgtm

Suggested reviewers

  • nobodyiam
  • hezhangjian

Poem

🐰 A rust-y client lands with grace,
Three versions claim their rightful place,
In docs both east and west so fine,
Attribution shines, a helpful sign,
The changelog hops with joyful ease! ✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'doc: Add rust apollo client link' directly and accurately summarizes the main change: adding documentation for a Rust Apollo client link across multiple documentation files (CHANGES.md, English, and Chinese guides).
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@jmjoy jmjoy marked this pull request as ready for review December 9, 2025 09:57
@dosubot dosubot bot added the size:S This PR changes 10-29 lines, ignoring generated files. label Dec 9, 2025
@jmjoy
Copy link
Contributor Author

jmjoy commented Dec 9, 2025

I have read the CLA Document and I hereby sign the CLA

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 00503d0 and 48ea46b.

📒 Files selected for processing (3)
  • CHANGES.md (1 hunks)
  • docs/en/client/rust-sdks-user-guide.md (1 hunks)
  • docs/zh/client/rust-sdks-user-guide.md (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: build (8)
🔇 Additional comments (2)
docs/zh/client/rust-sdks-user-guide.md (1)

12-19: Proper documentation addition following established patterns.

The new section follows the same structure and formatting as the existing Apollo Rust client sections above it, with correct attribution and project link.

CHANGES.md (1)

27-27: Changelog entry properly formatted and placed.

The entry follows the established format with correct markdown syntax and PR reference.

Comment on lines +14 to +19

### Apollo Rust client 3

Project address: [apollo-client](https://github.com/jmjoy/apollo-client)

> Thanks [@jmjoy](https://github.com/jmjoy) for providing support for the Rust Apollo client
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Minor punctuation inconsistency in the English documentation.

The new section uses a regular colon (Project address:) on line 17, but the existing sections above it use full-width colons (Project address:) on lines 3 and 11. For consistency within this document, please align the punctuation style.

Apply this diff to standardize the punctuation:

-Project address: [apollo-client](https://github.com/jmjoy/apollo-client)
+Project address: [apollo-client](https://github.com/jmjoy/apollo-client)
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
### Apollo Rust client 3
Project address: [apollo-client](https://github.com/jmjoy/apollo-client)
> Thanks [@jmjoy](https://github.com/jmjoy) for providing support for the Rust Apollo client
### Apollo Rust client 3
Project address [apollo-client](https://github.com/jmjoy/apollo-client)
> Thanks [@jmjoy](https://github.com/jmjoy) for providing support for the Rust Apollo client
🤖 Prompt for AI Agents
In docs/en/client/rust-sdks-user-guide.md around lines 14 to 19, the "Project
address:" label uses a regular colon while other entries use a full-width colon;
change the regular colon to a full-width colon (:) so the punctuation matches
the other sections and maintain document consistency.

Copy link
Member

@nobodyiam nobodyiam left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label Dec 13, 2025
@nobodyiam nobodyiam merged commit 8467359 into apolloconfig:master Dec 13, 2025
9 of 10 checks passed
@github-actions github-actions bot locked and limited conversation to collaborators Dec 13, 2025
@jmjoy jmjoy deleted the doc branch December 13, 2025 13:34
@nobodyiam nobodyiam added this to the 2.5.0 milestone Feb 19, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

lgtm This PR has been approved by a maintainer size:S This PR changes 10-29 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants