-
Notifications
You must be signed in to change notification settings - Fork 443
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
Docs : Content Organization and Documentation Updates #4850
Conversation
3e2e233
to
2d2d664
Compare
d5a2b46
to
6f06f9a
Compare
Note: Changes may take a few seconds to appear on GitHub Pages. Please refresh the page if you do not see the updates immediately. |
07055fa
to
b4534d1
Compare
@AdarshRawat1 Looks like previews are working now! |
a3fe7cb
to
f019160
Compare
Signed-off-by: Adarsh <Adarshbunny293@gmail.com>
Signed-off-by: Adarsh <Adarshbunny293@gmail.com>
Signed-off-by: Adarsh <Adarshbunny293@gmail.com>
Signed-off-by: Adarsh <Adarshbunny293@gmail.com>
Signed-off-by: Adarsh <Adarshbunny293@gmail.com>
Signed-off-by: Adarsh <Adarshbunny293@gmail.com>
Signed-off-by: Adarsh <Adarshbunny293@gmail.com>
Signed-off-by: Adarsh <Adarshbunny293@gmail.com>
Signed-off-by: Adarsh <Adarshbunny293@gmail.com>
Signed-off-by: Adarsh <Adarshbunny293@gmail.com>
Signed-off-by: Adarsh <Adarshbunny293@gmail.com>
Signed-off-by: Adarsh <Adarshbunny293@gmail.com>
…Backend Signed-off-by: Adarsh <Adarshbunny293@gmail.com>
Signed-off-by: Adarsh <Adarshbunny293@gmail.com>
Signed-off-by: Adarsh <Adarshbunny293@gmail.com>
Signed-off-by: Adarsh <Adarshbunny293@gmail.com>
Signed-off-by: Adarsh <Adarshbunny293@gmail.com>
Signed-off-by: Adarsh <Adarshbunny293@gmail.com>
Organize `portable_common` directory file descriptions into a table format Signed-off-by: Adarsh <Adarshbunny293@gmail.com>
Signed-off-by: Adarsh <Adarshbunny293@gmail.com>
Signed-off-by: Adarsh <Adarshbunny293@gmail.com>
Signed-off-by: Adarsh <Adarshbunny293@gmail.com>
Current default doxygen URL config Output- https://p4lang.github.io/p4c/md__2home_2runner_2work_2p4c_2p4c_2backends_2dpdk_2_r_e_a_d_m_e.html Updated - https://p4lang.github.io/p4c/dpdk_backend.html Signed-off-by: Adarsh <Adarshbunny293@gmail.com>
8840544
to
1f9cf35
Compare
- Added comments to indicate whether each README is included as a standalone page, a subsection, or not included in the P4 compiler documentation. - Provided specific links to relevant sections or pages within the documentation. Signed-off-by: Adarsh <Adarshbunny293@gmail.com>
Signed-off-by: Adarsh <Adarshbunny293@gmail.com>
Compatible with GitHub and Doxygen Signed-off-by: Adarsh <Adarshbunny293@gmail.com>
Signed-off-by: Adarsh <Adarshbunny293@gmail.com>
Signed-off-by: Adarsh <Adarshbunny293@gmail.com>
Signed-off-by: Adarsh <Adarshbunny293@gmail.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would factor out the textual and description changes to READMEs from the doxygen-internal changes. For example, moving the addition of the front end, mid end README and changes to lib, ir etc to a separate PR. It might make it easier to give a review here.
Sure!! I'll shift the changes to a seperate PR. |
Signed-off-by: Adarsh <Adarshbunny293@gmail.com> Co-authored-by: Fabian Ruffy <5960321+fruffy@users.noreply.github.com> Signed-off-by: Adarsh Rawat <adarshbunny293@gmail.com>
Signed-off-by: Adarsh <Adarshbunny293@gmail.com>
Signed-off-by: Adarsh <Adarshbunny293@gmail.com>
@fruffy Migrated the changes and updated the description of PR. |
Signed-off-by: Adarsh <Adarshbunny293@gmail.com>
Signed-off-by: Adarsh <Adarshbunny293@gmail.com>
* Migrate Content Updates from PR #4850 Signed-off-by: Adarsh <Adarshbunny293@gmail.com> * Fix: Formatting of IR Description tables Signed-off-by: Adarsh <Adarshbunny293@gmail.com> * Refactor: Shorter description for Pass library Signed-off-by: Adarsh <Adarshbunny293@gmail.com> * Remove Optimization Passes Section from Midend Signed-off-by: Adarsh <Adarshbunny293@gmail.com> * Improve front end description Co-authored-by: Fabian Ruffy <5960321+fruffy@users.noreply.github.com> Signed-off-by: Adarsh Rawat <adarshbunny293@gmail.com> * Formatting Changes P4_14 -> P4-14 P4_16 -> P4-16 Signed-off-by: Adarsh <Adarshbunny293@gmail.com> * Removed Pass library section from Midend Signed-off-by: Adarsh <Adarshbunny293@gmail.com> * Fix: Midend ref Link in doxygen Signed-off-by: Adarsh <Adarshbunny293@gmail.com> * Removed Extra lines from Midend Description Signed-off-by: Adarsh <Adarshbunny293@gmail.com> * Minor fix : Spacing Co-authored-by: Fabian Ruffy <5960321+fruffy@users.noreply.github.com> Signed-off-by: Adarsh Rawat <adarshbunny293@gmail.com> * Minor Refactor : IR Classes heading Signed-off-by: Adarsh <Adarshbunny293@gmail.com> Co-authored-by: Fabian Ruffy <5960321+fruffy@users.noreply.github.com> Signed-off-by: Adarsh Rawat <adarshbunny293@gmail.com> * Minor Fix: Spelling of 'Ternary' Signed-off-by: Adarsh <Adarshbunny293@gmail.com> Co-authored-by: Fabian Ruffy <5960321+fruffy@users.noreply.github.com> Signed-off-by: Adarsh Rawat <adarshbunny293@gmail.com> --------- Signed-off-by: Adarsh <Adarshbunny293@gmail.com> Signed-off-by: Adarsh Rawat <adarshbunny293@gmail.com> Co-authored-by: Fabian Ruffy <5960321+fruffy@users.noreply.github.com>
Configuration changes
After integration of Doxygen
v1.12.0
into our workflow., we've made several improvements to streamline the documentation process with Support of Doxygen Style comments.Documentation Maintenance
Changes in Content
Removed Sections
Merged Sections
PSA implementation for eBPF backend as a subsection under eBPF Backend
Combined P4Tools - Testing Tools For P4 Targets and P4Tools Contributors under a new page P4tools
Merged P4Testgen Benchmarks and P4Testgen BMv2 target tests in the P4Testgen Page
Combined Introduction to uBPF Backend
►uBPF Backend test programs
►uBPF Backend testing in a single page titled
uBPF Backend
.Merged Coding Standard into Contribute to the P4 Compiler Project
Merge Overview into P4C
Merged Common P4C utility functions as a subsection under P4C
Merged BMv2 "pna_nic" Backend into Behavioral Model Backend
Merge portable_common section under Behavioral Model Backend
merged P4C Intermediate Representation (IR) Classes as a subsection of P4 Compiler Intermediate representation .
Moved Sections
Renamed Sections