-
Notifications
You must be signed in to change notification settings - Fork 439
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 & Add 'Frontend' and 'Midend' Sections #4876
Conversation
Note: Changes may take a few seconds to appear on GitHub Pages. Please refresh the page if you do not see the updates immediately. |
Signed-off-by: Adarsh <[email protected]>
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.
Initial round of comments.
* Create Subsections of related topics Signed-off-by: Adarsh <[email protected]> * Remove Revision History Signed-off-by: Adarsh <[email protected]> * Exclude Subsections from generated Documentation Signed-off-by: Adarsh <[email protected]> * Remove: deprecated Section from generated docs Signed-off-by: Adarsh <[email protected]> * Disable Todo list Signed-off-by: Adarsh <[email protected]> * Docs : Hide Namespace and Classes section from output Signed-off-by: Adarsh <[email protected]> * Merge P4C Overview with P4C root README Signed-off-by: Adarsh <[email protected]> * Minor Fix : missing "`" in directory structure Signed-off-by: Adarsh <[email protected]> * Remove Revision History Signed-off-by: Adarsh <[email protected]> * Merge P4C Overview with P4C root README Signed-off-by: Adarsh <[email protected]> * Disable Auto Link support for classes/namespaces Signed-off-by: Adarsh <[email protected]> * Merge "Common P4C Utility Functions" as a subsection of "P4C" Page Signed-off-by: Adarsh <[email protected]> * Convert file descriptions to Markdown table format in BMv2 "pna_nic" Backend Signed-off-by: Adarsh <[email protected]> * Remove Revision History Signed-off-by: Adarsh <[email protected]> * Merge P4C Overview with P4C root README Signed-off-by: Adarsh <[email protected]> * Remove Revision History Signed-off-by: Adarsh <[email protected]> * Merge P4C Overview with P4C root README Signed-off-by: Adarsh <[email protected]> * Content for P4test Backend Signed-off-by: Adarsh <[email protected]> * Refactor : Organize `portable_common` directory file descriptions Organize `portable_common` directory file descriptions into a table format Signed-off-by: Adarsh <[email protected]> * Hide Doxygen Commands from GitHub Markdown render Using the New Doxygen comment style in v1.12.0 i.e. `<!-- ... -->` For details - #4861 Signed-off-by: Adarsh <[email protected]> * Create Subsections of related topics Signed-off-by: Adarsh <[email protected]> * Docs : Hide Namespace and Classes section from output Signed-off-by: Adarsh <[email protected]> * Merge P4C Overview with P4C root README Signed-off-by: Adarsh <[email protected]> * Remove Revision History Signed-off-by: Adarsh <[email protected]> * Merge P4C Overview with P4C root README Signed-off-by: Adarsh <[email protected]> * Content for P4test Backend Signed-off-by: Adarsh <[email protected]> * Fix : removed extra Command Signed-off-by: Adarsh <[email protected]> * Organize `IR` Classes descriptions into a table format Signed-off-by: Adarsh <[email protected]> * chore: Add TOC to content-rich pages Signed-off-by: Adarsh <[email protected]> * Remove TOC from Changelogs Signed-off-by: Adarsh <[email protected]> * Exclude GitHub markdown TOC from Doxygen output Signed-off-by: Adarsh <[email protected]> * Highlight sample backends in P4C with a dedicated heading Signed-off-by: Adarsh <[email protected]> * Merged: BMv2 "pna_nic" Backend into Behavioral Model Backend Signed-off-by: Adarsh <[email protected]> * Merge P4C IR Classes into IR Page Signed-off-by: Adarsh <[email protected]> * Change the top of tree view from "P4C" -> "P4 Compiler Documentation (P4C)" Signed-off-by: Adarsh <[email protected]> * Change root page heading "P4C" -> "Getting Started" Signed-off-by: Adarsh <[email protected]> * Move changelogs to the end of Side bar Signed-off-by: Adarsh <[email protected]> * Improve Getting started page heading Signed-off-by: Adarsh <[email protected]> * Merge "portable_common" section under "bmv2" Signed-off-by: Adarsh <[email protected]> * Minor formatting Fixes Signed-off-by: Adarsh <[email protected]> * Minor command fix Signed-off-by: Adarsh <[email protected]> * Fix: Broken Table structure in Doxygen output Signed-off-by: Adarsh <[email protected]> * Refactor : Page headings Signed-off-by: Adarsh <[email protected]> * Refactor : Ordering of backends Signed-off-by: Adarsh <[email protected]> * Enable Nice URL for generated docs 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 <[email protected]> * Doc: Add inclusion notes to Documented Markdown files - 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 <[email protected]> * Docs: Add remaining documentation inclusion notes Signed-off-by: Adarsh <[email protected]> * Add GitHub profile links for Core developers of p4tools Compatible with GitHub and Doxygen Signed-off-by: Adarsh <[email protected]> * Fix: formatting of inclusion note Signed-off-by: Adarsh <[email protected]> * Docs: Side bar grouping of backends Signed-off-by: Adarsh <[email protected]> * Add Introduction for Frontend and Midend Signed-off-by: Adarsh <[email protected]> * Update lib/README.md Signed-off-by: Adarsh <[email protected]> Co-authored-by: Fabian Ruffy <[email protected]> Signed-off-by: Adarsh Rawat <[email protected]> * Revert: Changes that are migrated to PR #4876 Signed-off-by: Adarsh <[email protected]> --------- Signed-off-by: Adarsh <[email protected]> Signed-off-by: Adarsh Rawat <[email protected]> Co-authored-by: Fabian Ruffy <[email protected]>
479770a
to
7ce09f1
Compare
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.
A couple more small things I have noticed.
843cdfb
to
c3068a2
Compare
Signed-off-by: Adarsh <[email protected]>
Signed-off-by: Adarsh <[email protected]>
Signed-off-by: Adarsh <[email protected]>
Signed-off-by: Adarsh <[email protected]>
Co-authored-by: Fabian Ruffy <[email protected]> Signed-off-by: Adarsh Rawat <[email protected]>
P4_14 -> P4-14 P4_16 -> P4-16 Signed-off-by: Adarsh <[email protected]>
Signed-off-by: Adarsh <[email protected]>
Signed-off-by: Adarsh <[email protected]>
Signed-off-by: Adarsh <[email protected]>
Co-authored-by: Fabian Ruffy <[email protected]> Signed-off-by: Adarsh Rawat <[email protected]>
Signed-off-by: Adarsh <[email protected]> Co-authored-by: Fabian Ruffy <[email protected]> Signed-off-by: Adarsh Rawat <[email protected]>
Signed-off-by: Adarsh <[email protected]> Co-authored-by: Fabian Ruffy <[email protected]> Signed-off-by: Adarsh Rawat <[email protected]>
c3068a2
to
807aa2c
Compare
Migrated Content Updates from PR
Added Content for Pages
Format Enhancements : Converted into tables
Links
Add GitHub profile links for Core developers of p4tools