Skip to content

docs(cpp): API reference main#79

Merged
WomB0ComB0 merged 1 commit into
mainfrom
auto/cpp-api-main
May 15, 2026
Merged

docs(cpp): API reference main#79
WomB0ComB0 merged 1 commit into
mainfrom
auto/cpp-api-main

Conversation

@WomB0ComB0
Copy link
Copy Markdown
Member

@WomB0ComB0 WomB0ComB0 commented May 15, 2026

Auto-generated by API docs (C++) in
resq-software/vcpkg for ref main
(run: 25922575484).

Regenerated files under sdks/cpp/api/. Doxygen extracted
declarations from each package's include/ headers; moxygen
converted them to Markdown.

Summary by CodeRabbit

  • Documentation
    • Standardized C++ SDK documentation navigation labels and formatting.

Review Change Stack

@github-actions github-actions Bot added area:content MDX/MD documentation content area:meta Repo meta — docs.json, README, etc. labels May 15, 2026
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 15, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 2cba15fd-e9c5-445d-a7dd-6a030e4640ee

📥 Commits

Reviewing files that changed from the base of the PR and between 547e008 and 8a69c7f.

📒 Files selected for processing (1)
  • docs.json

📝 Walkthrough

Walkthrough

A 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.

Changes

C++ SDK Navigation Configuration Update

Layer / File(s) Summary
C++ SDK group label update and file formatting
docs.json
The C++ SDK navigation group display name is updated to "resq-common", and the final closing brace is reformatted.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Suggested labels

area:content

Poem

🐰 A label shifts from grand to lean,
From "ResQ Common" to a smaller sheen—
resq-common now shows the way,
With tidy braces to close the day!

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Title check ❓ Inconclusive The title 'docs(cpp): API reference main' is vague and generic. While it mentions documentation and C++, it does not clearly convey what was actually changed in this PR (updating a navigation group label from 'ResQ Common' to 'resq-common'). Consider a more specific title that describes the actual change, such as 'docs(cpp): Update navigation label to resq-common' or similar, to make the primary modification clear when scanning commit history.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch auto/cpp-api-main

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.

Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

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

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.

Comment thread docs.json
"sdks/cpp/api/README",
{
"group": "ResQ Common",
"group": "resq-common",
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

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.

Suggested change
"group": "resq-common",
"group": "ResQ Common",
References
  1. In Mintlify docs.json navigation configuration, use a nested group object (e.g., {"group": "Label", "pages": ["path"]}) to define custom sidebar labels for pages.

@WomB0ComB0 WomB0ComB0 merged commit 9f7c5c7 into main May 15, 2026
13 checks passed
@WomB0ComB0 WomB0ComB0 deleted the auto/cpp-api-main branch May 15, 2026 14:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:content MDX/MD documentation content area:meta Repo meta — docs.json, README, etc. automated docs:api-ref language:cpp

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants