RadeonOpenCompute / ROCm_Documentation

Legacy ROCm Software Platform Documentation
http://rocm.docs.amd.com
113 stars 92 forks source link

Please split building and some other details from Installation_Guide to separate document #104

Open baryluk opened 3 years ago

baryluk commented 3 years ago

Installation_Guide.rst is now 1280 lines in the source.

This is ridiculous in my opinion.

200 would be acceptable, but even less would be better.

Building sections (including repo tool, git repo links, versions, etc) can be moved to own document. That will shave maybe 300 lines.

Some other sections also doesn't belong to the Installation Guide:

Machine Learning and High Performance Computing Software Stack for AMD GPU

Software Stack for AMD GPU

ROCm Platform Packages

and

List of ROCm Packages for Supported Operating Systems

sections can be moved to own documents or eradicated.

I would even say, that List of ROCm Packages for Supported Operating Systems should be removed completely, it is already redundant with other information in the document and outdated.

Rmalavally commented 3 years ago

We appreciate your interest in ROCm documentation and feedback. Thanks so much.

We are in the process of re-evaluating ROCm content on the documentation website for each component. Your suggestions are valid, and we will review them with the appropriate teams and make changes, as applicable, for a better user experience.

AMD ROCm Documentation Team

rkothako commented 3 years ago

Hi @Rmalavally I recommend to consider these changes and update docs accordingly. Thank you.

baryluk commented 3 years ago

I just noticed the new documentation. The one for ROCm 3.10.

Huge improvement! Thank you for making it better and easier for new users.

There is still some room for improvements, but I like where it is going.

Rmalavally commented 3 years ago

Thank you for your proactive and positive feedback. We are happy to know you are finding ROCm documentation improved and user friendly.

We appreciate your time and interest.

AMD ROCm Documentation Team