Improve the API reference landing page - #87
Open
jonathan343 wants to merge 5 commits into
Open
Conversation
Alan4506
requested changes
Aug 21, 2026
Alan4506
left a comment
Alan4506
left a comment
Contributor
There was a problem hiding this comment.
Thanks @jonathan343! Left some comments. Let me know if you have questions.
Alan4506
reviewed
Aug 23, 2026
|
|
||
| async with AsyncDynamoDBClient(config=config) as client: | ||
| response = await client.list_tables(input=ListTablesInput(limit=10)) | ||
| for table in response.table_names: |
Contributor
There was a problem hiding this comment.
It looks like the or [] was dropped from the line 98 in the latest commit. Without this, pyright now reports error: Object of type "None" cannot be used as iterable value (reportOptionalIterable), since we have table_names: list[str] | None = None defined in ListTablesOutput.
Do we want to change it back to for table in response.table_names or []:?
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.
Overview
The API reference currently inherits its landing page from the repository README, which leaves readers without a clear introduction to the SDK or path into the reference documentation.
This PR replaces it with a purpose-built overview and adds a dismissible Developer Preview notice across the docs. The banner ensures that users entering through deep links still see the production-use guidance.
Testing / Preview
make docs-installmake docsmake docs-serveBy submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.