Conversation
The README was outdated and missing structure expected from a modern OSS project. Rewrite it with a TOC, sync/async quick-start examples, a feature list with deep links into the docs (concepts, guides, upgrading), a documentation table, related projects, and support/contributing sections so users can discover the platform-side resources without leaving the repo.
vdusek
added
adhoc
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #776 +/- ##
==========================================
- Coverage 97.56% 97.50% -0.07%
==========================================
Files 47 47
Lines 4725 4725
==========================================
- Hits 4610 4607 -3
- Misses 115 118 +3
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
The new typed-models concept page is the right destination for that bullet — Upgrading to v3 only covers the migration story.
janbuchar
approved these changes
May 5, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The README was outdated (Quick start used a placeholder Actor, Features section was a four-bullet wall of text, no TOC, no links to the documentation site, no related-projects or community sections). This PR rewrites it to follow modern OSS conventions and to act as a proper entry point into the docs at https://docs.apify.com/api/client/python/docs.