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.

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

Merged
merged 53 commits into from
Aug 19, 2024

Conversation

AdarshRawat1
Copy link
Member

@AdarshRawat1 AdarshRawat1 commented Aug 3, 2024

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

  • Added clear documentation inclusion notes on all relevant markdown files.

Changes in Content

  • Combined all the Backends into one section.

Removed Sections

Merged Sections

Moved Sections

  • Changelogs to the end of list. Renamed to - > "Releases"

Renamed Sections

  • Change the top of tree view from "P4C" -> "P4 Compiler Documentation
  • "P4 Compiler Intermediate Representation" -> "P4C Intermediate Representation (IR),"
  • "P4C Intermediate Representation (IR) Classes" -> "Classes. (Because now it is a subsection under IR so it doesn't require long heading).

Copy link
Contributor

github-actions bot commented Aug 6, 2024

githubloading A preview of this PR is available at: Preview Link
📂 View the source code here: View Source Code
🔧 Commit used for deployment: adb7e384a80cc2017caa7f826494ddae0de5cde4

Note: Changes may take a few seconds to appear on GitHub Pages. Please refresh the page if you do not see the updates immediately.

@fruffy
Copy link
Collaborator

fruffy commented Aug 8, 2024

@AdarshRawat1 Looks like previews are working now!

@AdarshRawat1 AdarshRawat1 force-pushed the Docs-Side-Bar branch 3 times, most recently from a3fe7cb to f019160 Compare August 13, 2024 03:52
Signed-off-by: Adarsh <[email protected]>
Organize `portable_common` directory file descriptions into a table format
Signed-off-by: Adarsh <[email protected]>
- 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]>
@AdarshRawat1 AdarshRawat1 marked this pull request as ready for review August 17, 2024 06:31
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.

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.

CHANGELOG.md Show resolved Hide resolved
lib/README.md Outdated Show resolved Hide resolved
@AdarshRawat1
Copy link
Member Author

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 <[email protected]>

Co-authored-by: Fabian Ruffy <[email protected]>
Signed-off-by: Adarsh Rawat <[email protected]>
AdarshRawat1 added a commit to AdarshRawat1/p4c that referenced this pull request Aug 19, 2024
@AdarshRawat1 AdarshRawat1 marked this pull request as draft August 19, 2024 15:15
@AdarshRawat1 AdarshRawat1 requested a review from fruffy August 19, 2024 16:10
@AdarshRawat1
Copy link
Member Author

@fruffy Migrated the changes and updated the description of PR.

@AdarshRawat1 AdarshRawat1 marked this pull request as ready for review August 19, 2024 16:21
@fruffy fruffy added this pull request to the merge queue Aug 19, 2024
Merged via the queue into p4lang:main with commit c9fe41c Aug 19, 2024
19 checks passed
AdarshRawat1 added a commit to AdarshRawat1/p4c that referenced this pull request Aug 19, 2024
AdarshRawat1 added a commit to AdarshRawat1/p4c that referenced this pull request Aug 22, 2024
github-merge-queue bot pushed a commit that referenced this pull request Aug 22, 2024
* Migrate Content Updates from PR #4850

Signed-off-by: Adarsh <[email protected]>

* Fix: Formatting of IR Description tables

Signed-off-by: Adarsh <[email protected]>

* Refactor: Shorter description for Pass library

Signed-off-by: Adarsh <[email protected]>

* Remove Optimization Passes Section from Midend

Signed-off-by: Adarsh <[email protected]>

* Improve front end description

Co-authored-by: Fabian Ruffy <[email protected]>
Signed-off-by: Adarsh Rawat <[email protected]>

* Formatting Changes

P4_14 -> P4-14
P4_16 -> P4-16

Signed-off-by: Adarsh <[email protected]>

* Removed Pass library section from Midend

Signed-off-by: Adarsh <[email protected]>

* Fix: Midend ref Link in doxygen

Signed-off-by: Adarsh <[email protected]>

* Removed Extra lines from Midend Description

Signed-off-by: Adarsh <[email protected]>

* Minor fix : Spacing

Co-authored-by: Fabian Ruffy <[email protected]>
Signed-off-by: Adarsh Rawat <[email protected]>

* Minor Refactor : IR Classes heading

Signed-off-by: Adarsh <[email protected]>

Co-authored-by: Fabian Ruffy <[email protected]>
Signed-off-by: Adarsh Rawat <[email protected]>

* Minor Fix: Spelling of 'Ternary'

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]>
Signed-off-by: Adarsh Rawat <[email protected]>
Co-authored-by: Fabian Ruffy <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Topics related to compiler documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants