docs(python): API reference main - #19
Conversation
📝 WalkthroughWalkthroughThis PR adds documentation infrastructure for the ResQ Python SDK. A new README file introduces the SDK and links to two public PyPI packages ( ChangesPython SDK Documentation Setup
Poem
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 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.
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
📒 Files selected for processing (2)
sdks/python/api/README.mdsdks/python/api/_pages.json
There was a problem hiding this comment.
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.
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.
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>
Auto-generated by
api-docsinresq-software/pypifor refmain(run: 25602155559).
Regenerated files under
sdks/python/api/. Review thediff for unintended exports and merge to publish.