Closed
Conversation
- Added `CONTRIBUTING.md` to guide new contributors on development setup, testing workflows, and contributing best practices. - Expanded the `README.md` with detailed descriptions, quick-start examples, supported use cases, installation options, and deployment details. - Included Python SDK-specific workflows demonstrating both synchronous and asynchronous usage for the most common client operations. Assisted-by: Codex
- Included badges for test status and supported Python versions: - Tests: Links to GitHub Actions workflow. - Python Versions: Links to PyPI project page. - Enhances visibility of project health and compatibility. Assisted-by: Codex
- Added `llms.txt` and `llms-full.txt` as new machine-readable guides for LLMs and automated tools requiring SDK insights. - Included a badge in `README.md` linking to `llms.txt`. - Enhanced documentation accessibility for AI-driven workflows and code-assistant integrations. Assisted-by: Codex
✅ Deploy Preview for pdfrest-python ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
- Included a badge displaying the current PyPI version of the SDK. - Enhances visibility of the latest release for developers. Assisted-by: Codex
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
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.
PDFCLOUD-5597
Why this change
The repository README was accurate but too sparse for a public-facing GitHub and
PyPI landing page. It leaned heavily toward maintainer workflow commands and did
not reflect the SDK's current positioning, supported Python versions, or the
ways users discover and evaluate the product (for example API Lab, docs, and
PyPI metadata).
This change improves first-impression quality and onboarding by making the README
more product-forward, easier to scan, and more useful for both developers and
LLM-assisted tooling. It also moves contributor-focused commands out of the main
README so end users see a cleaner install + quickstart path.
What changed (high level)
This PR refreshes documentation and packaging metadata without changing runtime
SDK behavior.
README.mdas a user-facing landing page with stronger productpositioning, capabilities overview, AI/LLM workflow framing, and sync/async
quickstarts.
uv-first while keepingpipas a clear fallback forPyPI users.
versions, and
llms.txtavailability.CONTRIBUTING.mdto keepthe README focused on product discovery and onboarding.
docs/llms.txtanddocs/llms-full.txtto provide machine-readabledocs indexes/guides for LLM and agent tooling.
1.0.1to1.0.2and synceduv.lock.Behavior changes
There are no SDK runtime/API behavior changes in this PR.
What is different:
(badges, clearer value proposition, modern install commands, and quickstarts).
llms.txtandllms-full.txt(assumingstandard MkDocs file passthrough from
docs/), which makes the docs easier toconsume for LLM-based assistants and indexing tools.
CONTRIBUTING.mdinstead of the README.Validation
Validation performed:
upstream/main..HEADdiff for correctness and scope.>=3.10/ CI matrix 3.10-3.14)test-and-publish.yml)PdfRestClient,AsyncPdfRestClient)PDFCLOUD-5597).Not run (docs-only/package-metadata PR):
uv run ruff format .uv run ruff check .uv run basedpyrightuv run pytest -n auto --maxschedchunk 2uvx nox -s testsuv run mkdocs build --strictRisks and follow-ups
Primary risks are documentation quality/deployment concerns rather than code
regressions:
stable.
llms.txtandllms-full.txtbadges/links assume the docs deployment servesraw files from the MkDocs
docs/directory at the site root.1.0.2should align with release intent/timing for this PR.Follow-ups (if desired):
llms.txtand
llms-full.txtpublish at the expected paths.llms-full.txtfrom the docs home page in addition to themachine-readable
llms.txtpath.