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

[documentation] Add hyperlinks to the actual directory in the README file. #4531

Merged
merged 9 commits into from
Mar 16, 2024
Merged

[documentation] Add hyperlinks to the actual directory in the README file. #4531

merged 9 commits into from
Mar 16, 2024

Conversation

AdarshRawat1
Copy link
Member

@AdarshRawat1 AdarshRawat1 commented Mar 14, 2024 •
edited
Loading

Changes

  • Added directory link for examples directory in DPDK backend's Guide.
  • Added Directory link for "testdata/p4tc_samples" in Guide of "tc" Backend.
  • Added directory link for "examples" directory in "ubpf" backend's Guide.

@AdarshRawat1
Add directory link for examples in DPDK
7cb3ad4 
 Added directory link for examples directory in DPDK backend's Guide
@AdarshRawat1
[Docs] Add Directory link for p4tc_samples
9bf2397 
[Docs] Added Directory link for "testdata/p4tc_samples" in Guide of "tc" Backend.
@AdarshRawat1 AdarshRawat1 marked this pull request as ready for review March 14, 2024 04:52
jafingerhut
jafingerhut approved these changes Mar 14, 2024
View reviewed changes
Copy link
Contributor

@jafingerhut jafingerhut left a comment

Choose a reason for hiding this comment

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

LGTM

fruffy
fruffy requested changes Mar 15, 2024
View reviewed changes
Copy link
Collaborator

@fruffy fruffy left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Instead of making just the directory the link I would also include the term before. So examples and testdata/p4tc_samples

@AdarshRawat1
Copy link
Member Author

Instead of making just the directory the link I would also include the term before. So examples and testdata/p4tc_samples

Sure, that would be a better way of linking the resource.

@AdarshRawat1
Merge branch 'main' into Docs-5-minor-Accessibility-fixes
809493e
@AdarshRawat1
Add "examples" to link text
f92ee8a 
Added "examples" term as link text along with "directory".
@AdarshRawat1
Add "testdata/p4tc_samples" to link text
bd6a7f1 
Added "testdata/p4tc_samples" term as link text along with "directory".
@AdarshRawat1
Add directory link for "examples" in "ubpf"
06c0aa9 
Added directory link for examples directory in "ubpf" backend's Guide
@fruffy fruffy added the documentation Topics related to compiler documentation. label Mar 15, 2024
fruffy
fruffy reviewed Mar 16, 2024
View reviewed changes
backends/ubpf/README.md Outdated Show resolved Hide resolved
backends/tc/README.md Outdated Show resolved Hide resolved
AdarshRawat1 and others added 3 commits March 16, 2024 22:06
@AdarshRawat1 @fruffy
[Fix] Formatting of directory name
13ee581 
Co-authored-by: Fabian Ruffy <5960321+fruffy@users.noreply.github.com>
@AdarshRawat1 @fruffy
[Fix] Add 'the' before 'example' in documentation
d718cd9 
Co-authored-by: Fabian Ruffy <5960321+fruffy@users.noreply.github.com>
@AdarshRawat1
Merge branch 'main' into Docs-5-minor-Accessibility-fixes
d9fe14d
@fruffy fruffy changed the title [docs] [Accessibility]Add hyperlinks to the actual resource in README [documentation] Add hyperlinks to the actual resource in README Mar 16, 2024
@fruffy fruffy changed the title [documentation] Add hyperlinks to the actual resource in README [documentation] Add hyperlinks to the actual direction in the README file Mar 16, 2024
@fruffy fruffy changed the title [documentation] Add hyperlinks to the actual direction in the README file [documentation] Add hyperlinks to the actual directory in the README file Mar 16, 2024
@fruffy fruffy added this pull request to the merge queue Mar 16, 2024
@fruffy fruffy changed the title [documentation] Add hyperlinks to the actual directory in the README file [documentation] Add hyperlinks to the actual directory in the README file. Mar 16, 2024
Merged via the queue into p4lang:main with commit 386e56c Mar 16, 2024
17 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jafingerhut jafingerhut jafingerhut approved these changes

@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.
3 participants
@AdarshRawat1 @jafingerhut @fruffy