Skip to content

docs(python): API reference main - #19

Merged
WomB0ComB0 merged 1 commit into
mainfrom
auto/python-api-main
May 9, 2026
Merged

WomB0ComB0 merged 1 commit into
mainfrom
auto/python-api-main

Conversation

@WomB0ComB0

@WomB0ComB0 WomB0ComB0 commented May 9, 2026

Copy link
Copy Markdown
Member

Auto-generated by api-docs in
resq-software/pypi for ref main
(run: 25602155559).

Regenerated files under sdks/python/api/. Review the
diff for unintended exports and merge to publish.

@coderabbitai

coderabbitai Bot commented May 9, 2026

Copy link
Copy Markdown
📝 Walkthrough

Walkthrough

This PR adds documentation infrastructure for the ResQ Python SDK. A new README file introduces the SDK and links to two public PyPI packages (resq-mcp and resq-dsa), and the pages manifest is updated to register this README as a documented page.

Changes

Python SDK Documentation Setup

Layer / File(s) Summary
Pages Manifest
sdks/python/api/_pages.json
Pages manifest populated with "README" entry to register the SDK documentation page.
SDK Documentation
sdks/python/api/README.md
README added documenting the ResQ Python SDK as an auto-generated reference with links to resq-mcp and resq-dsa package overview pages.

Poem

🐰 A README takes flight,
Pages manifest glows bright,
SDK docs now unfold—
Two packages to behold! 📚✨

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title 'docs(python): API reference main' accurately describes the main change: updating the Python API reference documentation for the main branch.
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.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.

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

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch auto/python-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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@sdks/python/api/README.md`:
- Around line 3-4: Rewrite the README intro (first lines of
sdks/python/api/README.md) into a single active-voice sentence that addresses
the reader (use "you") and present the repository path resq-software/pypi using
code-style formatting; replace the fragment with a complete sentence like "This
document provides an auto-generated reference for the public packages in
resq-software/pypi" but ensure you use second person and active voice and format
the repo path as inline code in the file.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 5e1861e6-9901-41ba-9254-c85b013eac05

📥 Commits

Reviewing files that changed from the base of the PR and between eedd30a and 376c644.

📒 Files selected for processing (2)
  • sdks/python/api/README.md
  • sdks/python/api/_pages.json

Comment thread sdks/python/api/README.md

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

Copy link
Copy Markdown

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 initializes the ResQ Python SDK documentation by adding a README file and a basic _pages.json configuration. The reviewer suggested expanding the _pages.json file to include the overview pages for the resq-mcp and resq-dsa packages to ensure they are properly indexed in the documentation's sidebar navigation.

Comment thread sdks/python/api/_pages.json
@WomB0ComB0
WomB0ComB0 merged commit f364850 into main May 9, 2026
13 checks passed
WomB0ComB0 pushed a commit that referenced this pull request May 9, 2026
Single-line nav addition — points at sdks/python/api/README which
Mintlify resolves via the existing .md file. No file renames; the
auto-generated trees stay as .md because Mintlify's .md link
resolver is filesystem-based and already accepts the
cross-references TypeDoc / DefaultDocumentation / pydoc-markdown
emit. Renaming the READMEs to .mdx (attempted in earlier
commits 4e31133 / 7301dbc / 54934ef) was the wrong move —
.mdx parents have stricter link resolution that requires every
link target to be nav-registered, which is not feasible for
3500+ auto-generated pages.

The "is referenced in docs.json navigation but the file does
not exist" warning that mint dev emits for .md-extension README
references is cosmetic; Mintlify still renders the page.

The "Generated API Reference" group from PR #17 only had
TypeScript and .NET sub-groups; PR #18 (Python template) and
the resulting auto-PRs (#19, #20) landed the Python content
after that PR was opened.
WomB0ComB0 added a commit that referenced this pull request May 9, 2026
Single-line nav addition — points at sdks/python/api/README which
Mintlify resolves via the existing .md file. No file renames; the
auto-generated trees stay as .md because Mintlify's .md link
resolver is filesystem-based and already accepts the
cross-references TypeDoc / DefaultDocumentation / pydoc-markdown
emit. Renaming the READMEs to .mdx (attempted in earlier
commits 4e31133 / 7301dbc / 54934ef) was the wrong move —
.mdx parents have stricter link resolution that requires every
link target to be nav-registered, which is not feasible for
3500+ auto-generated pages.

The "is referenced in docs.json navigation but the file does
not exist" warning that mint dev emits for .md-extension README
references is cosmetic; Mintlify still renders the page.

The "Generated API Reference" group from PR #17 only had
TypeScript and .NET sub-groups; PR #18 (Python template) and
the resulting auto-PRs (#19, #20) landed the Python content
after that PR was opened.

Co-authored-by: Mike Odnis <engineer@resq.software>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants