DOC: Better Organize Project README Using Table of Contents

[ssharp0]

Pandas version checks

• I have checked that the issue still exists on the latest versions of the docs on main here

Location of the documentation

https://github.com/pandas-dev/pandas/blob/main/README.md

Documentation problem

I wanted to provide an idea and proposal that I believe may help improve the pandas github README documentation. I would like to suggest adding a table of contents within the README file. I do not see any related issue in 'issues'.

Suggested fix for documentation

I believe a clearly visible table of contents embedded within the README could be helpful for users to quickly navigate the document. I understand there is the built in menu item icon on the README that provides this navigation functionality (so it already exists in some fashion) but it may not be immediately clear or intuitive for everyone.

I also believe adding a link to go back to the top of the README could be helpful to save a user from scrolling.

Table of Contents

• Main Features
• Where to get it
• Dependencies
• Installation from sources
• License
• Documentation
• Background
• Getting Help
• Discussion and Development
• Contributing to pandas

Go to Top

[ssharp0]

take