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.

Sign up for GitHub

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

Jump to bottom

Add a table of contents to the README #4589

Closed
fruffy opened this issue Apr 1, 2024 · 1 comment · Fixed by #4590
Closed

Add a table of contents to the README #4589

fruffy opened this issue Apr 1, 2024 · 1 comment · Fixed by #4590
Assignees
@AdarshRawat1
Labels
enhancement This topic discusses an improvement to existing compiler code. good-first-issue An issue that could be solved by someone new to the code base.

Comments

@fruffy
Copy link
Collaborator

fruffy commented Apr 1, 2024 •
edited
Loading

Our README is quite large and can be difficult to navigate. Add a table of contents at the top to make navigation a little easier.

https://github.com/ekalinin/github-markdown-toc
@fruffy fruffy added enhancement This topic discusses an improvement to existing compiler code. good-first-issue An issue that could be solved by someone new to the code base. labels Apr 1, 2024
@AdarshRawat1
Copy link
Member

This would be great to have. I'll send a PR soon.

@AdarshRawat1 AdarshRawat1 mentioned this issue Apr 1, 2024
Merged
2 tasks
@fruffy fruffy linked a pull request Apr 4, 2024 that will close this issue
[Docs] Add Table of Content #4590
Merged
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@AdarshRawat1 AdarshRawat1

Labels
enhancement This topic discusses an improvement to existing compiler code. good-first-issue An issue that could be solved by someone new to the code base.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

[Docs] Add Table of Content AdarshRawat1/p4c
2 participants
@fruffy @AdarshRawat1