docs:apollo c++ client sdk#5398
Conversation
dosubot
bot
added
the
size:XS
WalkthroughA new section introducing the Apollo C++ client has been added to both the English and Chinese C++ SDK user guide documentation files. The section includes a GitHub repository link and an acknowledgment to the contributor, without any changes to code or public interfaces. Additionally, sidebar entries linking to the new guides were added in both languages. Changes
Suggested labels
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (2)
✅ Files skipped from review due to trivial changes (2)
⏰ Context from checks skipped due to timeout of 90000ms (1)
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed 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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
|
CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅ |
|
I have read the CLA Document and I hereby sign the CLA |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
docs/zh/client/cpp-sdks-user-guide.md (1)
4-4: Refine acknowledgment formatting in Chinese
Add spaces around the GitHub mention and a full‐width period at the end for consistency with other Chinese docs.- > 非常感谢[@jiazhanfeng](https://github.com/jiazhanfeng1989)提供C++ Apollo客户端的支持 + > 非常感谢 [@jiazhanfeng](https://github.com/jiazhanfeng1989) 提供 C++ Apollo 客户端的支持。docs/en/client/cpp-sdks-user-guide.md (1)
5-5: Add punctuation to support English grammar
Include a period at the end of the acknowledgment sentence to match the style of other documentation.- > Thanks [@jiazhanfeng](https://github.com/jiazhanfeng1989) for providing support for the C++ Apollo client + > Thanks [@jiazhanfeng](https://github.com/jiazhanfeng1989) for providing support for the C++ Apollo client.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docs/en/client/cpp-sdks-user-guide.md(1 hunks)docs/zh/client/cpp-sdks-user-guide.md(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: build (8)
🔇 Additional comments (2)
docs/zh/client/cpp-sdks-user-guide.md (1)
1-3:Details
✅ Verification successful
Ensure Chinese heading consistency and link label
Please verify that the section title “Apollo C++ 客户端” and the spacing around “C++” match existing Chinese SDK guides. Also consider using a more descriptive label such as “GitHub 仓库地址：” instead of “项目地址：” for clarity.
🏁 Script executed:
#!/bin/bash # Verify Chinese client SDK section naming conventions in the docs rg "### .+ 客户端" -n docs/zh/clientLength of output: 1790
I’ll check how other SDK guides label their repo links for consistency.
🏁 Script executed:
#!/bin/bash echo "Occurrences of '项目地址' in docs/zh/client:" rg -n -C1 "项目地址" docs/zh/client/*.md echo echo "Occurrences of '仓库地址' in docs/zh/client:" rg -n -C1 "仓库地址" docs/zh/client/*.mdLength of output: 7616
Heading and link label are consistent as-is
Verified that the section title “### Apollo C++ 客户端” follows the same pattern as other SDK guides (e.g. “### Apollo Rust 客户端”). All Chinese client guides uniformly use “项目地址：” for GitHub links, so no update is needed here.docs/en/client/cpp-sdks-user-guide.md (1)
1-3:Details
✅ Verification successful
Verify consistent labeling of the C++ client repository link
Check whether other English SDK guides use “Project address”, “Repository”, or “GitHub repository” to ensure uniform style across docs.
🏁 Script executed:
#!/bin/bash # Search for repository link labels in English client SDK guides rg -n "Project address" -A1 docs/en/clientLength of output: 4543
Uniform “Project address” label confirmed
All English client SDK guides (C++, Rust, PHP, Python, Node.js, Go, C) consistently use Project address for their repository links. No changes needed.
nobodyiam
left a comment
nobodyiam
left a comment
There was a problem hiding this comment.
You may also need to update _sidebar.md and run docsify serve docs to check if it works.
dosubot
bot
added
size:S
Done, and checked with |
3 participants
What's the purpose of this PR
add apollo c++ client sdk
Follow this checklist to help us incorporate your contribution quickly and easily:
mvn clean testto make sure this pull request doesn't break anything.CHANGESlog.Summary by CodeRabbit