Skip to content

PDFCLOUD-5597 Readme updates#35

Closed
datalogics-kam wants to merge 5 commits intopdfrest:mainfrom
datalogics-kam:pdfcloud-5597-readme-updates
Closed

PDFCLOUD-5597 Readme updates#35
datalogics-kam wants to merge 5 commits intopdfrest:mainfrom
datalogics-kam:pdfcloud-5597-readme-updates

Conversation

@datalogics-kam
Copy link
Copy Markdown
Contributor

@datalogics-kam datalogics-kam commented Feb 23, 2026

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.

  • Rewrote README.md as a user-facing landing page with stronger product
    positioning, capabilities overview, AI/LLM workflow framing, and sync/async
    quickstarts.
  • Made install guidance uv-first while keeping pip as a clear fallback for
    PyPI users.
  • Added top-of-README badges for CI status, PyPI version, supported Python
    versions, and llms.txt availability.
  • Moved contributor/dev workflow commands into a new CONTRIBUTING.md to keep
    the README focused on product discovery and onboarding.
  • Added docs/llms.txt and docs/llms-full.txt to provide machine-readable
    docs indexes/guides for LLM and agent tooling.
  • Bumped package version metadata from 1.0.1 to 1.0.2 and synced uv.lock.

Behavior changes

There are no SDK runtime/API behavior changes in this PR.

What is different:

  • GitHub and PyPI users will see a substantially improved README experience
    (badges, clearer value proposition, modern install commands, and quickstarts).
  • The documentation site will publish llms.txt and llms-full.txt (assuming
    standard MkDocs file passthrough from docs/), which makes the docs easier to
    consume for LLM-based assistants and indexing tools.
  • Contributor instructions now live in CONTRIBUTING.md instead of the README.

Validation

Validation performed:

  • Reviewed upstream/main..HEAD diff for correctness and scope.
  • Verified README claims against current repository/package state, including:
    • supported Python versions (>=3.10 / CI matrix 3.10-3.14)
    • workflow file name used by the CI badge (test-and-publish.yml)
    • docs site URL and docs page paths used in links
    • SDK public client names (PdfRestClient, AsyncPdfRestClient)
  • Confirmed PR branch/title alignment with Jira key (PDFCLOUD-5597).

Not run (docs-only/package-metadata PR):

  • uv run ruff format .
  • uv run ruff check .
  • uv run basedpyright
  • uv run pytest -n auto --maxschedchunk 2
  • uvx nox -s tests
  • uv run mkdocs build --strict

Risks and follow-ups

Primary risks are documentation quality/deployment concerns rather than code
regressions:

  • README links/badges depend on canonical upstream repo/docs URLs remaining
    stable.
  • llms.txt and llms-full.txt badges/links assume the docs deployment serves
    raw files from the MkDocs docs/ directory at the site root.
  • Version bump to 1.0.2 should align with release intent/timing for this PR.

Follow-ups (if desired):

  • Add a docs build check run for this branch before merge to verify llms.txt
    and llms-full.txt publish at the expected paths.
  • Consider linking llms-full.txt from the docs home page in addition to the
    machine-readable llms.txt path.

- 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
@netlify
Copy link
Copy Markdown

netlify Bot commented Feb 23, 2026

Deploy Preview for pdfrest-python ready!

Name Link
🔨 Latest commit be94941
🔍 Latest deploy log https://app.netlify.com/projects/pdfrest-python/deploys/699c857e9a731d00083e0464
😎 Deploy Preview https://deploy-preview-35--pdfrest-python.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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
@datalogics-kam datalogics-kam marked this pull request as ready for review February 23, 2026 16:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants