Refresh out-of-date docs - #349
Merged
Merged
Conversation
Generated client methods are snake_case, so the example calls `client.say`, not `client.Say`. It also imports `SayRequest`, which the snippet uses but never imported. Signed-off-by: Stefan VanBuren <stefan@vanburen.xyz>
The API reference link added in #224 was lost when the README was rewritten. Restore it, pointing at the site's current URL under `connect-py`. Signed-off-by: Stefan VanBuren <stefan@vanburen.xyz>
DEVELOPMENT.md said all documentation lives in connectrpc.com, but the API reference is built from this repo with zensical. Point to `docs/` and the `docs-build` and `docs-serve` tasks. Signed-off-by: Stefan VanBuren <stefan@vanburen.xyz>
DEVELOPMENT.md called `poe check` "all checks", but it only runs lint, unit tests, and connectrpc-otel tests. Say so, and list the `test-grpcreflect` and `test-conformance` tasks that CI also runs. Signed-off-by: Stefan VanBuren <stefan@vanburen.xyz>
The contributing steps in DEVELOPMENT.md duplicated CONTRIBUTING.md and had drifted from it: they left out the DCO sign-off and opening an issue before changing a public API. Link to CONTRIBUTING.md instead. Signed-off-by: Stefan VanBuren <stefan@vanburen.xyz>
RELEASE.md only covered `connectrpc`, but the otel and grpcreflect packages release on their own `connectrpc-otel/v*` and `connectrpc-grpcreflect/v*` tags. Describe how their bump, tag, and release naming differ, matching past releases such as `connectrpc-otel/v0.2.0` from #277. Signed-off-by: Stefan VanBuren <stefan@vanburen.xyz>
The API reference documented `connectrpc_grpcreflect` but not `connectrpc_otel`. Add it so `OpenTelemetryInterceptor` is documented. Signed-off-by: Stefan VanBuren <stefan@vanburen.xyz>
`ConnectInstrumentor` is exported and registered as the `opentelemetry_instrumentor` entry point, but without a docstring the API reference skipped it. Describe what it instruments and the keyword arguments `instrument()` accepts. Signed-off-by: Stefan VanBuren <stefan@vanburen.xyz>
The `:::` directives had no blank lines between them and carried indented `options:` blocks, so GitHub and Neovim ran each group together into one paragraph. Separate every directive and move the options into `zensical.toml`: `show_submodules` applies globally, and `filters = "public"` lets `__all__` choose the `connectrpc_grpcreflect` members. The grpcreflect classes now render in source order rather than the hand-picked order; the set of documented objects is unchanged. Signed-off-by: Stefan VanBuren <stefan@vanburen.xyz>
stefanvanburen
commented
Sep 25, 2026
Member
Author
There was a problem hiding this comment.
open to suggestions on wording here.
stefanvanburen
commented
Sep 25, 2026
| # API Reference | ||
|
|
||
| ::: connectrpc.client | ||
|
|
Member
Author
There was a problem hiding this comment.
honestly don't mind reverting this; just triggered my "let's fix this" when I saw it rendered in GitHub markdown
stefanvanburen
commented
Sep 25, 2026
Comment on lines
-27
to
-34
| - ServerReflectionService | ||
| - ServerReflectionASGIApplication | ||
| - ServerReflectionServiceSync | ||
| - ServerReflectionWSGIApplication | ||
| - ServerReflectionAlphaService | ||
| - ServerReflectionAlphaASGIApplication | ||
| - ServerReflectionAlphaServiceSync | ||
| - ServerReflectionAlphaWSGIApplication |
Member
Author
There was a problem hiding this comment.
not sure if we wanted this ordering on-purpose?
Collaborator
There was a problem hiding this comment.
IIRC it was so alpha doesn't show above non-alpha, which is probably a good idea
Member
Author
There was a problem hiding this comment.
put it back and added an HTML comment, so should be invisible: 191c394
stefanvanburen
commented
Sep 25, 2026
| Connect is the **easiest way to build modern APIs**. | ||
|
|
||
| [Docs](https://connectrpc.com/docs/python/getting-started/) • | ||
| [API reference](https://connectrpc.github.io/connect-py/api/) • |
Member
Author
There was a problem hiding this comment.
not exactly sure where this ought to live, but this seemed ok. seemed like it ought to live on the README somewhere if we were committed to continue to publish it.
stefanvanburen
marked this pull request as ready for review
September 25, 2026 01:04
anuraaga
approved these changes
Sep 25, 2026
anuraaga
left a comment
anuraaga
left a comment
Collaborator
There was a problem hiding this comment.
Thanks! Just one point about the ordering
The explicit `members` list keeps each v1 class above its v1alpha counterpart, which source order does not (#349 (comment)). Restore it with a comment saying why. Signed-off-by: Stefan VanBuren <stefan@vanburen.xyz>
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
2 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.
A pass over the READMEs and contributor docs to fix things that drifted from the code. The connectrpc-otel README example called
client.Sayand never importedSayRequest, the main README lost its API reference link in the rewrite, and DEVELOPMENT.md still said all documentation lives in connectrpc.com.DEVELOPMENT.md now says what
poe checkactually runs and defers to CONTRIBUTING.md instead of keeping a copy that had dropped the DCO and open-an-issue-first steps. RELEASE.md gains a section on releasing connectrpc-otel and connectrpc-grpcreflect under their own tags, matching how past releases were cut.The API reference now includes
connectrpc_otel, andConnectInstrumentorgets a docstring so it renders there; its behavior is unchanged.