Improve the API reference landing page - #87
Conversation
Alan4506
left a comment
Alan4506
left a comment
There was a problem hiding this comment.
Thanks @jonathan343! Left some comments. Let me know if you have questions.
| from the standard AWS configuration sources. The `region` argument overrides | ||
| the configured region for this client. | ||
|
|
||
| ## Documentation and support |
There was a problem hiding this comment.
Not blocking:
We can add a link to the developer guide once it gets released in the future.
|
|
||
| async def main(): | ||
| config = await AsyncDynamoDBConfig.resolve(region="us-east-1") | ||
| client = AsyncDynamoDBClient(config=config) |
There was a problem hiding this comment.
Let's modify this code block to sync up with the new pattern established in smithy-lang/smithy-python#765.
Consider aysnc with to use the context manager.
|
|
||
| ## List DynamoDB tables | ||
|
|
||
| After you [configure AWS credentials](https://docs.aws.amazon.com/sdkref/latest/guide/standardized-credentials.html) |
There was a problem hiding this comment.
The link points to the sdkref Standardized credential providers page, which lists the full set of providers - but our developer preview only supports a subset. Readers may pick an unsupported method (e.g., SSO) and hit failures.
Should we give users more explicit instructions about how to set up credentials, like #85? Once the developer guide gets released, we can link to one of its sections that lists out supported providers.
| ## Install a client | ||
|
|
||
| The clients require Python 3.12 or later. | ||
|
|
There was a problem hiding this comment.
Do we want to introduce virtual environment setup between Python version requirement and client installation?
See Boto3 documentation: https://docs.aws.amazon.com/boto3/latest/guide/quickstart.html.
2 participants
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.