Skip to content

docs: full-parity README and concrete docs link#1

Merged
lesnik512 merged 1 commit into
mainfrom
docs/readme-polish
Jul 12, 2026
Merged

docs: full-parity README and concrete docs link#1
lesnik512 merged 1 commit into
mainfrom
docs/readme-polish

Conversation

@lesnik512

Copy link
Copy Markdown
Member

What

  • Rewrites the README from the two-line stub into the standard integration template used by the polished repos (aiohttp, fastapi, litestar, …): badge row, Installation, Usage with a runnable sync-server example, API table, and the modern-python footer.
  • Points the pyproject [project.urls] Documentation at the concrete https://modern-di.modern-python.org/integrations/grpc/ page instead of the site root, so the PyPI sidebar "Documentation" link lands on the gRPC guide.
  • Adds an inline "Full guide" link to the same concrete page.

Why

The gRPC README was a title + one sentence + a root-domain docs link — the emptiest of the integrations. This brings it to parity with the rest of the fleet. Repo homepage + topics are set separately via repo settings.

Content is derived from the existing gRPC integration docs and the package's public exports; no code changes.

🤖 Generated with Claude Code

Expand the README to the standard integration template (badges, install,
usage example, API table, footer) and point the pyproject Documentation URL
at the concrete integrations/grpc/ docs page instead of the site root.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@lesnik512
lesnik512 merged commit aa3f6f7 into main Jul 12, 2026
6 checks passed
@lesnik512
lesnik512 deleted the docs/readme-polish branch July 12, 2026 17:27
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.

1 participant