docs(python): API reference main#76
Conversation
github-actions
Bot
added
area:content
|
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 (2)
📝 WalkthroughWalkthroughThis PR updates Python SDK documentation by standardizing navigation labels to lowercase in the documentation configuration and pinning specific package versions in the README alongside API reference metadata for the ResQ Python SDK packages. ChangesPython SDK Documentation Updates
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Suggested labels
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Tip 💬 Introducing Slack Agent: The best way for teams to turn conversations into code.Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.
Built for teams:
One agent for your entire SDLC. Right inside Slack. 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 |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates the Python SDK documentation by adding version numbers to the package list and converting navigation group names in docs.json to lowercase. Feedback suggests reverting the group names to Title Case to maintain consistency with the existing documentation structure.
| "sdks/python/api/README", | ||
| { | ||
| "group": "ResQ DSA", | ||
| "group": "resq-dsa", |
There was a problem hiding this comment.
The group name has been changed to lowercase (resq-dsa), which is inconsistent with the Title Case naming convention used for other SDK sections in this file (e.g., TypeScript on line 72, ResQ.Blockchain on line 1494). Reverting to ResQ DSA ensures a consistent and professional appearance in the navigation sidebar.
| "group": "resq-dsa", | |
| "group": "ResQ DSA", |
References
- In Mintlify docs.json navigation configuration, use a nested group object to define custom sidebar labels for pages, as the schema does not support a label property within the pages array.
| }, | ||
| { | ||
| "group": "ResQ MCP", | ||
| "group": "resq-mcp", |
There was a problem hiding this comment.
This group name should remain Title Case (ResQ MCP) to maintain consistency with the rest of the documentation's navigation structure.
| "group": "resq-mcp", | |
| "group": "ResQ MCP", |
References
- In Mintlify docs.json navigation configuration, use a nested group object to define custom sidebar labels for pages, as the schema does not support a label property within the pages array.
| "sdks/python/api/resq-mcp/tools", | ||
| { | ||
| "group": "Core", | ||
| "group": "core", |
There was a problem hiding this comment.
Sub-group names should follow the Title Case pattern used throughout the repository's documentation configuration for UI consistency.
| "group": "core", | |
| "group": "Core", |
References
- In Mintlify docs.json navigation configuration, use a nested group object to define custom sidebar labels for pages, as the schema does not support a label property within the pages array.
| }, | ||
| { | ||
| "group": "Drone", | ||
| "group": "drone", |
There was a problem hiding this comment.
Reverting to Drone to maintain the established Title Case naming pattern in the navigation sidebar.
| "group": "drone", | |
| "group": "Drone", |
References
- In Mintlify docs.json navigation configuration, use a nested group object to define custom sidebar labels for pages, as the schema does not support a label property within the pages array.
| }, | ||
| { | ||
| "group": "Dtsop", | ||
| "group": "dtsop", |
There was a problem hiding this comment.
Reverting to Dtsop to maintain the established Title Case naming pattern in the navigation sidebar.
| "group": "dtsop", | |
| "group": "Dtsop", |
References
- In Mintlify docs.json navigation configuration, use a nested group object to define custom sidebar labels for pages, as the schema does not support a label property within the pages array.
| }, | ||
| { | ||
| "group": "Hce", | ||
| "group": "hce", |
There was a problem hiding this comment.
Reverting to Hce to maintain the established Title Case naming pattern in the navigation sidebar.
| "group": "hce", | |
| "group": "Hce", |
References
- In Mintlify docs.json navigation configuration, use a nested group object to define custom sidebar labels for pages, as the schema does not support a label property within the pages array.
| }, | ||
| { | ||
| "group": "Pdie", | ||
| "group": "pdie", |
There was a problem hiding this comment.
Reverting to Pdie to maintain the established Title Case naming pattern in the navigation sidebar.
| "group": "pdie", | |
| "group": "Pdie", |
References
- In Mintlify docs.json navigation configuration, use a nested group object to define custom sidebar labels for pages, as the schema does not support a label property within the pages array.
2 participants
Auto-generated by
api-docsinresq-software/pypifor refmain(run: 25919452211).
Regenerated files under
sdks/python/api/. Review thediff for unintended exports and merge to publish.
Summary by CodeRabbit