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

[Docs] Add Table of Content #4590

Merged
merged 10 commits into from
Apr 4, 2024
Merged

[Docs] Add Table of Content #4590

merged 10 commits into from
Apr 4, 2024

Conversation

AdarshRawat1
Copy link
Member

@AdarshRawat1 AdarshRawat1 commented Apr 1, 2024 •
edited
Loading

fixes

Tasks Done

  • Add a table of contents at the top to make navigation a little easier.

Better Navigation

Proposed [Status - Dropped]

  • Describe p4c just over the TOC [ Optional ]

To provide a quick introduction of what the repository holds. Reason - Directly giving the TOC can be odd.

image

@AdarshRawat1 AdarshRawat1 marked this pull request as ready for review April 1, 2024 18:41
fruffy
fruffy requested changes Apr 1, 2024
View reviewed changes
Copy link
Collaborator

@fruffy fruffy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@fruffy fruffy added the documentation Topics related to compiler documentation. label Apr 1, 2024
@fruffy
Copy link
Collaborator

fruffy commented Apr 3, 2024

This will be out of date after #4580 so let's wait for that.

@AdarshRawat1 AdarshRawat1 marked this pull request as draft April 3, 2024 18:45
@AdarshRawat1 AdarshRawat1 marked this pull request as ready for review April 4, 2024 14:45
@AdarshRawat1
Copy link
Member Author

AdarshRawat1 commented Apr 4, 2024 •
edited
Loading

TOC is now in sync, with the updated README structure.

fruffy
fruffy reviewed Apr 4, 2024
View reviewed changes
README.md Outdated Show resolved Hide resolved
@fruffy fruffy linked an issue Apr 4, 2024 that may be closed by this pull request
Add a table of contents to the README #4589
Closed
fruffy
fruffy reviewed Apr 4, 2024
View reviewed changes
README.md Outdated Show resolved Hide resolved
@AdarshRawat1 AdarshRawat1 force-pushed the Docs-11-Adding-Table-of-content branch from e92e836 to a162d50 Compare April 4, 2024 16:13
fruffy
fruffy approved these changes Apr 4, 2024
View reviewed changes
Copy link
Collaborator

@fruffy fruffy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, thanks!

This also shows that there is some work to do in simplifying the main readme.

@fruffy fruffy enabled auto-merge April 4, 2024 16:50
@fruffy fruffy added this pull request to the merge queue Apr 4, 2024
Merged via the queue into p4lang:main with commit 3e3726a Apr 4, 2024
17 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Abhinavcode13 Abhinavcode13 Abhinavcode13 left review comments

@fruffy fruffy fruffy approved these changes

Assignees
No one assigned
Labels
documentation Topics related to compiler documentation.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add a table of contents to the README
3 participants
@AdarshRawat1 @fruffy @Abhinavcode13