Skip to content

DOC: Add Visible Table of Contents to Project README Documentation #53504

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

Merged
merged 5 commits into from
Jun 2, 2023

Conversation

ssharp0
Copy link
Contributor

@ssharp0 ssharp0 commented Jun 2, 2023

I have added a table of contents to the projects main README markdown file on my feature branch. I applied the same header styling to match the rest of the README. I tested the links on my branch and it all works.

I typically look for a table of contents on READMEs and I find it to be a valuable resource so I wanted to provide a suggestion to the issue I opened referenced above.

@mroeschke mroeschke added the Docs label Jun 2, 2023
@mroeschke mroeschke added this to the 2.1 milestone Jun 2, 2023
@mroeschke mroeschke merged commit 55d2a34 into pandas-dev:main Jun 2, 2023
@mroeschke
Copy link
Member

Great thanks @ssharp0

topper-123 pushed a commit to topper-123/pandas that referenced this pull request Jun 5, 2023
…andas-dev#53504)

* added table of content navlinks

* new line at end of file and removed whitespace, pre-commit hooks pass
Daquisu pushed a commit to Daquisu/pandas that referenced this pull request Jul 8, 2023
…andas-dev#53504)

* added table of content navlinks

* new line at end of file and removed whitespace, pre-commit hooks pass
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

DOC: Better Organize Project README Using Table of Contents
2 participants