-
Notifications
You must be signed in to change notification settings - Fork 43
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
doc reorg with src folder #195
Conversation
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.
The landing page has 5 boxes.
However, the folder structure is flat.
Shouldn't they correspond? Or are we limited with the changes we can preform?
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 think this looks good, @lawruble13 @cgmb do you have any feedback on this PR? |
@cgmb and @lawruble13 - please review this PR and share your feedback |
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 have a couple minor suggestions for the introduction, but it looks good to me.
consistency across these different components. ROCm CMake build tools are primarily | ||
used when building a library, and as such are not runtime dependencies for any generated | ||
libraries, packages, or executables. |
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 like to ensure we mention that the ROCm CMake build tools are not required for building programs that depend on ROCm. It's a very common point of confusion.
consistency across these different components. ROCm CMake build tools are primarily | ||
used when building a library, and as such are not runtime dependencies for any generated |
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.
Instead of "primarily used when building a library," could we be more specific and mention that they're used during development too? e.g., "The ROCm CMake build tools are used when building and developing many AMD ROCm libraries, but are not runtime dependencies for any libraries, packages or executables."
* doc reorg with src folder (#195) * doc reorg with src folder * leo's comments * added Files and Content * Update codeowners for docs * reorg based on Paul's feedback --------- Co-authored-by: Sam Wu <22262939+samjwu@users.noreply.github.com> * add Cory's comments --------- Co-authored-by: Sam Wu <22262939+samjwu@users.noreply.github.com>
* doc reorg with src folder (#195) * doc reorg with src folder * leo's comments * added Files and Content * Update codeowners for docs * reorg based on Paul's feedback --------- Co-authored-by: Sam Wu <22262939+samjwu@users.noreply.github.com> * add Cory's comments --------- Co-authored-by: Sam Wu <22262939+samjwu@users.noreply.github.com>
reorganized docs presentation using the current docs/src folder configuration