-
Notifications
You must be signed in to change notification settings - Fork 0
docs(python): API reference main #76
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -2071,7 +2071,7 @@ | |||||
| "pages": [ | ||||||
| "sdks/python/api/README", | ||||||
| { | ||||||
| "group": "ResQ DSA", | ||||||
| "group": "resq-dsa", | ||||||
| "pages": [ | ||||||
| "sdks/python/api/resq-dsa/bloom", | ||||||
| "sdks/python/api/resq-dsa/count_min", | ||||||
|
|
@@ -2082,7 +2082,7 @@ | |||||
| ] | ||||||
| }, | ||||||
| { | ||||||
| "group": "ResQ MCP", | ||||||
| "group": "resq-mcp", | ||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This group name should remain Title Case (ResQ MCP) to maintain consistency with the rest of the documentation's navigation structure.
Suggested change
References
|
||||||
| "pages": [ | ||||||
| "sdks/python/api/resq-mcp/core", | ||||||
| "sdks/python/api/resq-mcp/drone", | ||||||
|
|
@@ -2097,7 +2097,7 @@ | |||||
| "sdks/python/api/resq-mcp/telemetry", | ||||||
| "sdks/python/api/resq-mcp/tools", | ||||||
| { | ||||||
| "group": "Core", | ||||||
| "group": "core", | ||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Sub-group names should follow the Title Case pattern used throughout the repository's documentation configuration for UI consistency.
Suggested change
References
|
||||||
| "pages": [ | ||||||
| "sdks/python/api/resq-mcp/core/config", | ||||||
| "sdks/python/api/resq-mcp/core/errors", | ||||||
|
|
@@ -2108,30 +2108,30 @@ | |||||
| ] | ||||||
| }, | ||||||
| { | ||||||
| "group": "Drone", | ||||||
| "group": "drone", | ||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Reverting to Drone to maintain the established Title Case naming pattern in the navigation sidebar.
Suggested change
References
|
||||||
| "pages": [ | ||||||
| "sdks/python/api/resq-mcp/drone/models", | ||||||
| "sdks/python/api/resq-mcp/drone/service" | ||||||
| ] | ||||||
| }, | ||||||
| { | ||||||
| "group": "Dtsop", | ||||||
| "group": "dtsop", | ||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Reverting to Dtsop to maintain the established Title Case naming pattern in the navigation sidebar.
Suggested change
References
|
||||||
| "pages": [ | ||||||
| "sdks/python/api/resq-mcp/dtsop/models", | ||||||
| "sdks/python/api/resq-mcp/dtsop/service", | ||||||
| "sdks/python/api/resq-mcp/dtsop/tools" | ||||||
| ] | ||||||
| }, | ||||||
| { | ||||||
| "group": "Hce", | ||||||
| "group": "hce", | ||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Reverting to Hce to maintain the established Title Case naming pattern in the navigation sidebar.
Suggested change
References
|
||||||
| "pages": [ | ||||||
| "sdks/python/api/resq-mcp/hce/models", | ||||||
| "sdks/python/api/resq-mcp/hce/service", | ||||||
| "sdks/python/api/resq-mcp/hce/tools" | ||||||
| ] | ||||||
| }, | ||||||
| { | ||||||
| "group": "Pdie", | ||||||
| "group": "pdie", | ||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Reverting to Pdie to maintain the established Title Case naming pattern in the navigation sidebar.
Suggested change
References
|
||||||
| "pages": [ | ||||||
| "sdks/python/api/resq-mcp/pdie/models", | ||||||
| "sdks/python/api/resq-mcp/pdie/service" | ||||||
|
|
@@ -2554,4 +2554,4 @@ | |||||
| "website": "https://resq.software" | ||||||
| } | ||||||
| } | ||||||
| } | ||||||
| } | ||||||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,9 +1,8 @@ | ||
| # ResQ Python SDK | ||
|
|
||
| You can use this auto-generated reference for the public packages in | ||
| [`resq-software/pypi`](https://github.com/resq-software/pypi). | ||
| Auto-generated API reference for [`resq-software/pypi`](https://github.com/resq-software/pypi) at ref `main`. | ||
|
|
||
| ## Packages | ||
|
|
||
| - `resq-dsa` | ||
| - `resq-mcp` | ||
| - `resq-dsa` — `v1.3.4` | ||
| - `resq-mcp` — `v1.3.3` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
References