Table of contents for Boto3 API docs

[chamal-perera-19]

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

[khushail]

Hi @chamal-perera-19 , thanks for reaching out. For now, this is what has been adopted by team and would not be possible to change anytime soon. But I understand your concerns and it would be great if you could share your ideas in more detailed format reg the restructuring of documentation or page structure in mind. I could pitch that to team for their insights

[chamal-perera-19]

One thing is you can make page break into headings and then add those links to the right side bar where user clicks on a particular links, the page auto scrolls to that location.

You can add accordian to group the content so and make it by default closed, so the page scroll is smaller.

These are the things that I could think of, but definitley your team can think of more ways to improve the content quality.

[RyanFitzSimmonsAK]

I definitely see the value in a heading table of contents, similar to what the AWS CLI documentation has. I'll bring that to the team for their review, and let you know when I have any updates.

[chamal-perera-19]

Yes, definitely some kind of UI improvements are needed. Especially if you a newbie, and getting to know about the API, it is very hard, scrolling up and down.

[RyanFitzSimmonsAK]

Thanks for your patience. After talking with the team, a table of contents for Boto3 documentation is definitely something we see value in. I don't have a timeline for implementation at this time, but I'll be leaving this feature request open for tracking purposes, and will let you know if I have any updates. I'm going to adjust the title of this issue to reflect what the issue is tracking now. Thanks again for this feature request.