oneapi-src
doc: build: updates to build from source
Description
Addressing the recommendations in the DOC 13142
Quick summary of changes:
- Added an introductory sentence at the beginning of the document.|
- Download the Library: Added the "cd" command
- Build Library: Added formatting changes in the Build Library section and converted second-level headers into a numbered list
- Converted bulleted list into numbered list throughout the doc
- Added "Optional" identifier for Build documentation step
- Install Library: Converted the text into a note for better visibility
Hi @uxlfoundation/onednn-doc @uxlfoundation/onednn-arch please review when you have a moment, thanks!
This is the first round of DX review, left comments and also suggestions where possible
A lot of comments are around the commands. Adding @spalicki for review.
This is the first round of DX review, left comments and also suggestions where possible
A lot of comments are around the commands. Adding @spalicki for review.
I have added my comments to existing review.
Still a few issues to address, and a bit of polishing would help. Before requesting a review next time, please take a moment to visually check the rendered pages. Thanks for improving the structure!
Thanks, Maria for your review. I usually look at the rendered output before pushing commits however, this time around the commit got accidentally pushed.
@ranukund If we want to make it easy to parse for new developers, how about we streamline the documentation reorganize the structure and remove all the duplicated commands and notes? Something similar to #3395
Should I handle this PR in phases, cherry-pick the latest stable version, and publish the approved changes? In the next PR, I can address the remaining comments if required. @mzhukova @spalicki - please let me know what suits.
Should I handle this PR in phases, cherry-pick the latest stable version, and publish the approved changes? In the next PR, I can address the remaining comments if required. @mzhukova @spalicki - please let me know what suits.
hi @ranukund, I think there are just a few threads + minor comments left, it would be great to have them resolved before merging so to not loose track and also to keep Build page update self-contained. Thanks!
Should I handle this PR in phases, cherry-pick the latest stable version, and publish the approved changes? In the next PR, I can address the remaining comments if required. @mzhukova @spalicki - please let me know what suits.
hi @ranukund, I think there are just a few threads + minor comments left, it would be great to have them resolved before merging so to not loose track and also to keep Build page update self-contained. Thanks!
Hi @mzhukova I've addressed your comments.
@uxlfoundation/onednn-arch @uxlfoundation/onednn-doc I'll need one more approval to merge.