docs(cpp): API reference main#79
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughA minor documentation configuration update changes the C++ SDK navigation group label from "ResQ Common" to "resq-common" in docs.json and adjusts file-ending formatting. ChangesC++ SDK Navigation Configuration Update
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Suggested labels
Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
Code Review
This pull request modifies the docs.json file to change the group name for "ResQ Common" to kebab-case. The reviewer pointed out that this change is inconsistent with the Title Case naming convention used for other SDK groups in the documentation and suggested reverting it to maintain UI consistency.
| "sdks/cpp/api/README", | ||
| { | ||
| "group": "ResQ Common", | ||
| "group": "resq-common", |
There was a problem hiding this comment.
The group name has been changed to kebab-case (resq-common), which is inconsistent with the Title Case naming convention used for other SDK groups in this file (e.g., "ResQ DSA" at line 2074, "ResQ AI" at line 2155, and "ResQ MCP" at line 2085). To maintain a consistent user interface, this should remain "ResQ Common". This aligns with the requirement to use nested group objects for sidebar labels in Mintlify.
| "group": "resq-common", | |
| "group": "ResQ Common", |
References
- In Mintlify docs.json navigation configuration, use a nested group object (e.g., {"group": "Label", "pages": ["path"]}) to define custom sidebar labels for pages.
Auto-generated by
API docs (C++)inresq-software/vcpkgfor refmain(run: 25922575484).
Regenerated files under
sdks/cpp/api/. Doxygen extracteddeclarations from each package's
include/headers; moxygenconverted them to Markdown.
Summary by CodeRabbit