Skip to content

Conversation

qqiao
Copy link
Contributor

@qqiao qqiao commented Jun 28, 2025

What's the purpose of this PR

This PR is to add links in the documentation for https://github.com/qqiao/apollo-rust-client. A new Rust based client that supports both native Rust and NodeJS via cross compilation to WASM.

Brief changelog

Add link to https://github.com/qqiao/apollo-rust-client.

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.
  • Update the CHANGES log.

Summary by CodeRabbit

  • Documentation
    • Added new sections introducing the "Apollo Rust Client" and "Apollo NodeJS(WebAssembly) client 8" in both English and Chinese user guides for NodeJS and Rust SDKs.
    • Included project repository links and acknowledgments to contributors.
    • Expanded information on Rust and WASM client support without altering existing content.

@dosubot dosubot bot added the size:S This PR changes 10-29 lines, ignoring generated files. label Jun 28, 2025
Copy link

github-actions bot commented Jun 28, 2025

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

Copy link
Contributor

coderabbitai bot commented Jun 28, 2025

Warning

Rate limit exceeded

@qqiao has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 25 minutes and 45 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between e04f3ad and 99434ca.

📒 Files selected for processing (3)
  • docs/en/client/nodejs-sdks-user-guide.md (1 hunks)
  • docs/zh/client/nodejs-sdks-user-guide.md (1 hunks)
  • docs/zh/client/rust-sdks-user-guide.md (1 hunks)

Walkthrough

A new documentation section titled "Apollo Rust Client" was added to both English and Chinese user guides for Node.js and Rust SDKs. This section introduces a Rust and WASM-compatible Apollo client, includes a repository link, and credits the contributor. No existing content or code functionality was changed.

Changes

Files Change Summary
docs/en/client/nodejs-sdks-user-guide.md
docs/en/client/rust-sdks-user-guide.md
docs/zh/client/nodejs-sdks-user-guide.md
docs/zh/client/rust-sdks-user-guide.md
Added a new "Apollo Rust Client" section introducing a Rust/WASM Apollo client with repo link and contributor credit.

Suggested labels

lgtm

Poem

A new doc appears, so crisp and neat,
Apollo in Rust—what a treat!
With WASM support, the future is bright,
Thanks to qqiao, coding takes flight.
Hop, hop, hooray, the docs now sing—
More clients for Apollo, let the praises ring!
🥕


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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

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: 0

🧹 Nitpick comments (4)
docs/en/client/nodejs-sdks-user-guide.md (1)

42-49: Section label & gratitude text are misleading – update to reflect a Rust client, fix “NodeJS” spelling

  1. The Node.js SDKs guide suddenly lists a Rust client. Because this client only runs in Node.js via WASM, add a short parenthetical note to avoid confusing readers who expect a pure-JS client.
  2. “NodeJS” → “Node.js” (official spelling) in line 49.
  3. Gratitude line should say “Rust Apollo client”, not “NodeJS Apollo client”.
-### Apollo Rust Client
+Apollo Rust Client (runs in Node.js via WASM)

 ...
-> Thanks to [@qqiao](https://github.com/qqiao) for providing support for the NodeJS Apollo client
+> Thanks to [@qqiao](https://github.com/qqiao) for providing support for the Rust Apollo client
docs/zh/client/rust-sdks-user-guide.md (1)

6-11: 统一大小写与专有名词格式

  • “apollo 客户端” → “Apollo 客户端” 以保持专有名词大小写一致。
  • 如果希望与上方标题区分,可在第 8 行句末加句号。
-一个同时支持 Rust 以及 WASM 的 apollo 客户端
+一个同时支持 Rust 以及 WASM 的 Apollo 客户端。
docs/zh/client/nodejs-sdks-user-guide.md (1)

43-48: 缺少标点并且大小写不一致

  1. 在第 45 行中文句末缺少句号。
  2. “apollo 客户端” → “Apollo 客户端”。
  3. 行 48 的感谢语说“NodeJS Apollo客户端”,但此处介绍 Rust 客户端,建议改为 “Rust Apollo 客户端”。
  4. “NodeJS” → “Node.js”。
-一个同时支持 Rust 以及 WASM 的 apollo 客户端
+一个同时支持 Rust 以及 WASM 的 Apollo 客户端。

-> 非常感谢[@qqiao](https://github.com/qqiao)提供NodeJS Apollo客户端的支持
+> 非常感谢[@qqiao](https://github.com/qqiao)提供 Rust Apollo 客户端的支持
docs/en/client/rust-sdks-user-guide.md (1)

7-13: Minor wording consistency

Consider lower-casing “WASM” to match most Rust/Wasm docs (“Wasm”) and drop the leading article for brevity.

-A client for Apollo that supports both Rust and WASM.
+A client for Apollo that supports both Rust and Wasm.
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f4bdc04 and 6d006ba.

📒 Files selected for processing (4)
  • docs/en/client/nodejs-sdks-user-guide.md (1 hunks)
  • docs/en/client/rust-sdks-user-guide.md (1 hunks)
  • docs/zh/client/nodejs-sdks-user-guide.md (1 hunks)
  • docs/zh/client/rust-sdks-user-guide.md (1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/en/client/nodejs-sdks-user-guide.md

[uncategorized] ~49-~49: The official spelling of this programming framework is “Node.js”.
Context: ...om/qqiao) for providing support for the NodeJS Apollo client

(NODE_JS)

docs/zh/client/nodejs-sdks-user-guide.md

[uncategorized] ~45-~45: A punctuation mark might be missing here.
Context: ...Client 一个同时支持 Rust 以及 WASM 的 apollo 客户端 项目地址:[apollo-rust-client](https://github...

(AI_EN_LECTOR_MISSING_PUNCTUATION)

⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: build (8)

@qqiao
Copy link
Contributor Author

qqiao commented Jun 28, 2025

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

@qqiao
Copy link
Contributor Author

qqiao commented Jun 28, 2025

recheck

@qqiao
Copy link
Contributor Author

qqiao commented Jun 29, 2025

Updated as suggested

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

🧹 Nitpick comments (1)
docs/en/client/nodejs-sdks-user-guide.md (1)

43-44: Prefer official spelling “Node.js” for consistency

The project’s docs generally use “Node.js”. Updating the new heading and gratitude line keeps terminology uniform.

-### Apollo NodeJS(WebAssembly) client 8
+### Apollo Node.js (WebAssembly) client 8

-> Thanks to [@qqiao](https://github.com/qqiao) for providing support for the NodeJS Apollo client
+> Thanks to [@qqiao](https://github.com/qqiao) for providing support for the Node.js Apollo client

Also applies to: 49-49

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6d006ba and e04f3ad.

📒 Files selected for processing (2)
  • docs/en/client/nodejs-sdks-user-guide.md (1 hunks)
  • docs/en/client/rust-sdks-user-guide.md (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/en/client/rust-sdks-user-guide.md
🧰 Additional context used
🪛 LanguageTool
docs/en/client/nodejs-sdks-user-guide.md

[uncategorized] ~43-~43: The official spelling of this programming framework is “Node.js”.
Context: ...or the NodeJS Apollo client ### Apollo NodeJS(WebAssembly) client 8 A client for Apo...

(NODE_JS)


[uncategorized] ~49-~49: The official spelling of this programming framework is “Node.js”.
Context: ...om/qqiao) for providing support for the NodeJS Apollo client

(NODE_JS)

⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: build (8)

qqiao and others added 2 commits June 29, 2025 14:39
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
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

@nobodyiam nobodyiam merged commit 2139d2a into apolloconfig:master Jun 29, 2025
8 checks passed
@github-actions github-actions bot locked and limited conversation to collaborators Jun 29, 2025
@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label Jun 29, 2025
@qqiao qqiao deleted the add-apollo-rust-client-links branch June 29, 2025 13:27
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