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

doc reorg with src folder #195

Merged
merged 10 commits into from
Aug 17, 2024
Merged

doc reorg with src folder #195

merged 10 commits into from
Aug 17, 2024

Conversation

randyh62
Copy link
Contributor

@randyh62 randyh62 commented Jun 7, 2024

reorganized docs presentation using the current docs/src folder configuration

Copy link

@lpaoletti lpaoletti left a 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?

docs/src/index.rst Outdated Show resolved Hide resolved
Copy link

@lpaoletti lpaoletti left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this just be Documentation to align with the other headers?

image

@randyh62 randyh62 requested a review from lpaoletti June 10, 2024 16:37
@randyh62 randyh62 requested review from a team and lpaoletti and removed request for lpaoletti June 14, 2024 16:57
@randyh62 randyh62 closed this Jun 14, 2024
@randyh62 randyh62 requested review from a team and lpaoletti and removed request for lpaoletti June 14, 2024 17:02
@randyh62 randyh62 self-assigned this Jun 14, 2024
@randyh62 randyh62 reopened this Jun 14, 2024
@randyh62 randyh62 requested a review from a team June 14, 2024 17:42
@pfultz2
Copy link
Collaborator

pfultz2 commented Jul 30, 2024

I think this looks good, @lawruble13 @cgmb do you have any feedback on this PR?

@amitkumar-amd
Copy link

@cgmb and @lawruble13 - please review this PR and share your feedback

Copy link
Collaborator

@cgmb cgmb left a 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.

Comment on lines +19 to +21
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.
Copy link
Collaborator

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.

Comment on lines +19 to +20
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
Copy link
Collaborator

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."

@cgmb cgmb merged commit fcd8a82 into ROCm:develop Aug 17, 2024
7 of 9 checks passed
randyh62 added a commit that referenced this pull request Aug 21, 2024
* 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>
randyh62 added a commit that referenced this pull request Aug 21, 2024
* 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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants