docs: audit and update documentation for release readiness (closes #114) - #117
Merged
Conversation
joshrotenberg
marked this pull request as ready for review
June 2, 2026 14:28
Merged
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.
Summary
Documentation audit and update for release readiness. Covers all significant
changes since v0.9.5 that weren't yet reflected in docs.
Changes:
CHANGELOG.md: add missing[Unreleased]entries for simplified alias façade (api(consistency): finish harmonized handler surface across remaining domains #65 / PR feat(api): add simplified alias methods across remaining domain handlers (closes #65) #112) and Python parity expansion (python(parity): define and close the gap between Rust client and Python bindings #66 / PR feat(python): expand bindings to cover all major read domains, document parity scope (closes #66) #113); consolidate duplicate### Changedsections; reorder per Keep a Changelog convention (Added → Changed → Fixed)README.md: update Quick Start and examples to prefer simplified alias methods; update API coverage section to reflect 100% spec coverage; clarify empty allowlistssrc/lib.rs: update handler overview table to show individual connectivity handlers (VpcPeeringHandler,TransitGatewayHandler,PscHandler,PrivateLinkHandler) and addCostReportHandler; update subscription examples to uselist()alias; update feature listpython/README.md: fix Out-of-scope section —put/patchare not exposed as raw HTTP helpers in the Python bindingsexamples/basic.rs: preferlist()overget_all_subscriptions()examples/databases.rs: preferlist()overget_subscription_databases()with updated iterationTest plan
cargo doc --no-deps --all-features 2>&1 | grep warningproduces no outputcargo test --workspacepassescargo clippy --workspace --all-targets -- -D warningsis clean[Unreleased]has entries for api(consistency): finish harmonized handler surface across remaining domains #65 and python(parity): define and close the gap between Rust client and Python bindings #66python/src/client.rs