Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Making the Documentation Easy to Read #4448

Open
2 tasks
chamal-perera-19 opened this issue Feb 24, 2025 · 0 comments
Open
2 tasks

Making the Documentation Easy to Read #4448

chamal-perera-19 opened this issue Feb 24, 2025 · 0 comments
Labels
feature-request This issue requests a feature. needs-triage This issue or PR still needs to be triaged.

Comments

@chamal-perera-19
Copy link

Describe the feature

Hi Team,

I have a small feedback on the AWS Boto3 documentation.

It will be great if you can make the documentation more readable by making the improvements to the UI.

As an example,
https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/client/delete_item.html

In the above documentation page, it shows you all the details of the dynamo db delete item, which is great, but you have scroll up and down many many times to see the request structure, to see the description of each attribute item or to see the example.

If you can make some improvement so that users like us, does not have to scroll through a large content by making some UI improvements to all the documentation pages.

Use Case

I am always frustrated when I have go scroll many times to see and understand the documentation.

Proposed Solution

Please include as an example accordion or other UI improvements to make the documentation more easy navigate and readable.

Other Information

No response

Acknowledgements

  • I may be able to implement this feature request
  • This feature might incur a breaking change

SDK version used

AWS Boto3 1.36.26

Environment details (OS name and version, etc.)

Windows

@chamal-perera-19 chamal-perera-19 added feature-request This issue requests a feature. needs-triage This issue or PR still needs to be triaged. labels Feb 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature-request This issue requests a feature. needs-triage This issue or PR still needs to be triaged.
Projects
None yet
Development

No branches or pull requests

1 participant