New page structure

README.md

@@ -34,16 +34,15 @@ HIP releases are typically naming convention for each ROCM release to help diffe
   This type of release is typically made once a month.*
 
 ## More Info:
-- [Installation](docs/how_to_guides/install.md)
-- [HIP FAQ](docs/user_guide/faq.md)
+- [Installation](docs/how_to/install.md)
 - [HIP Kernel Language](docs/reference/kernel_language.md)
-- [HIP Porting Guide](docs/user_guide/hip_porting_guide.md)
-- [HIP Porting Driver Guide](docs/user_guide/hip_porting_driver_api.md)
-- [HIP Programming Guide](docs/user_guide/programming_manual.md)
-- [HIP Logging ](docs/developer_guide/logging.md)
-- [Building HIP From Source](docs/developer_guide/build.md)
-- [HIP Debugging ](docs/how_to_guides/debugging.md)
-- [HIP RTC](docs/user_guide/hip_rtc.md)
+- [HIP Porting Guide](docs/how_to/hip_porting_guide.md)
+- [HIP Porting Driver Guide](docs/conceptual/porting_driver.md)
+- [HIP Programming Guide](docs/conceptual/programming_manual.md)
+- [HIP Logging ](docs/reference/logging.md)
+- [Building HIP From Source](docs/how_to/build.md)
+- [HIP Debugging ](docs/how_to/debugging.md)
+- [HIP RTC](docs/conceptual/hip_rtc.md)
 - [HIP Terminology](docs/reference/terms.md) (including Rosetta Stone of GPU computing terms across CUDA/HIP/OpenCL)
 - [HIPIFY](https://github.com/ROCm-Developer-Tools/HIPIFY/blob/amd-staging/README.md)
 - Supported CUDA APIs:
@@ -56,12 +55,12 @@ HIP releases are typically naming convention for each ROCM release to help diffe
   * [cuDNN](https://github.com/ROCm-Developer-Tools/HIPIFY/blob/master/doc/markdown/CUDNN_API_supported_by_HIP.md)
   * [cuFFT](https://github.com/ROCm-Developer-Tools/HIPIFY/blob/master/doc/markdown/CUFFT_API_supported_by_HIP.md)
   * [cuSPARSE](https://github.com/ROCm-Developer-Tools/HIPIFY/blob/master/doc/markdown/CUSPARSE_API_supported_by_HIP.md)
-- [Developer/CONTRIBUTING Info](docs/developer_guide/contributing.md)
+- [Developer/CONTRIBUTING Info](docs/additional_resources/contributing.md)
 - [Release Notes](RELEASE.md)
 
 ## How do I get set up?
 
-See the [Installation](docs/how_to_guides/install.md) notes.
+See the [Installation](docs/how_to/install.md) notes.
 
 ## Simple Example
 The HIP API includes functions such as hipMalloc, hipMemcpy, and hipFree.
@@ -131,7 +130,7 @@ cd samples/01_Intro/square
 # follow README / blog steps to hipify the application.
 ```
 
-* Guide to [Porting a New Cuda Project](docs/user_guide/hip_porting_guide.md/"Porting a New CUDA Project")
+* Guide to [Porting a New Cuda Project](docs/how_to/porting.md/"Porting a New CUDA Project")
 
 
 ## More Examples

docs/.gitignore

@@ -1,4 +1,4 @@
-/_build
+_build
 /_doxygen
 /_images
 /_static

docs/.sphinx/_toc.yml.in

@@ -1,36 +1,27 @@
 root: index
 subtrees:
-- caption: User Reference
+- caption: Conceptual
+  entries:
+    - file: conceptual/hip_rtc
+    - file: conceptual/programming_manual
+- caption: How-to
+  entries:
+    - file: how_to/install
+    - file: how_to/build
+    - file: how_to/debugging
+    - file: how_to/porting
+- caption:  Reference
   entries:
     - file: .doxygen/docBin/html/index
     - file: reference/programming_model
     - file: reference/kernel_language
     - file: reference/math_api
-    - file: reference/glossary
     - file: reference/deprecated_api_list
-- caption: User How to Guides
-  entries:
-    - file: how_to_guides/install.md
-- caption: User Tutorials
-  entries:
-    - file: tutorials/saxpy.md
-- caption: Developer How to Guides
-  entries:
-    - file: developer_guide/build
-- caption: Legacy Reference
-  entries:
     - file: reference/terms
-- caption: Legacy User Guide
-  entries:
-    - file: user_guide/programming_manual
-    - file: user_guide/hip_rtc
-    - file: user_guide/faq
-- caption: Legacy How to Guides
+    - file: reference/logging
+- caption: Tutorials
   entries:
-    - file: how_to_guides/debugging.md
-    - file: user_guide/hip_porting_guide
-    - file: user_guide/hip_porting_driver_api
-- caption: Legacy Developer Guide
+    - file: tutorials/saxpy
+- caption: Additional resources
   entries:
-    - file: developer_guide/logging
-    - file: developer_guide/contributing.md
+    - file: additional_resources/contributing

docs/user_guide/faq.md → docs/additional_resources/faq.md

@@ -195,7 +195,7 @@ hipCUResultTohipError
 If platform portability is important, use #ifdef __HIP_PLATFORM_NVIDIA__ to guard the CUDA-specific code.
 
 ## How do I trace HIP application flow?
-See {doc}`/developer_guide/logging` for more information.
+See {doc}`/reference/logging` for more information.
 
 ## What is maximum limit of kernel launching parameter?
 Product of block.x, block.y, and block.z should be less than 1024.

docs/user_guide/programming_manual.md → docs/conceptual/programming_manual.md

@@ -129,7 +129,7 @@ HIP now supports runtime compilation (hipRTC), the usage of which will provide t
 hipRTC APIs accept HIP source files in character string format as input parameters and create handles of programs by compiling the HIP source files without spawning separate processes.
 
 For more details on hipRTC APIs, refer to HIP-API.pdf in GitHub (https://docs.amd.com/category/api_documentation).
-For Linux developers, the link here(https://github.com/ROCm-Developer-Tools/hip-tests/blob/develop/samples/2_Cookbook/23_cmake_hiprtc/saxpy.cpp) shows an example how to program HIP application using runtime compilation mechanism, and detail hipRTC programming guide is also available in Github (https://github.com/ROCm-Developer-Tools/HIP/blob/develop/docs/user_guide/hip_rtc.md).
+For Linux developers, the link here(https://github.com/ROCm-Developer-Tools/hip-tests/blob/develop/samples/2_Cookbook/23_cmake_hiprtc/saxpy.cpp) shows an example how to program HIP application using runtime compilation mechanism, and detail hipRTC programming guide is also available in Github (https://github.com/ROCm-Developer-Tools/HIP/blob/develop/docs/conceptual/hip_rtc.md).
 
 ## HIP Graph
 HIP graph is supported. For more details, refer to the HIP API Guide.

docs/conf.py

@@ -7,7 +7,7 @@
 from rocm_docs import ROCmDocs
 from typing import Any, Dict, List
 
-docs_core = ROCmDocs("HIP Documentation")
+docs_core = ROCmDocs("HIP Runtime documentation")
 docs_core.run_doxygen()
 docs_core.enable_api_reference()
 docs_core.setup()

docs/how_to_guides/install.md → docs/how_to/install.md

@@ -48,6 +48,6 @@ Run hipconfig (instructions below assume default installation path):
 # How to build HIP from source
 
 Developers can build HIP from source on either AMD or NVIDIA platforms, see
-detailed instructions at  [building HIP from source](../developer_guide/build.md).
+detailed instructions at  [building HIP from source](../how_to/build.md).
 
 

docs/index.md

@@ -1,100 +1,42 @@
-# HIP Documentation
+# HIP Runtime documentation
 
-HIP is a C++ runtime API and kernel language that allows developers to create
-portable applications for AMD and NVIDIA GPUs from single source code.
+HIP Runtime is a C++ API and kernel language that you can use to create portable applications for
+AMD and NVIDIA GPUs from single source code.
 
-## Programmer Manual
-
-These documents are targeted at authors of HIP libraries and applications.
-
-::::{grid} 1 1 2 2
-:gutter: 1
-
-:::{grid-item-card} Reference
-
-- {doc}`/.doxygen/docBin/html/index`
-  - {doc}`/.doxygen/docBin/html/modules`
-- {doc}`/reference/kernel_language`
-- {doc}`/reference/math_api`
-- {doc}`/reference/deprecated_api_list`
-
-:::
-
-:::{grid-item-card} Understand HIP
-:::
-
-:::{grid-item-card} How-to Guides
-
-- {doc}`/how_to_guides/install`
-
-:::
-
-:::{grid-item-card} Tutorials
-
-- {doc}`/tutorials/saxpy`
-
-:::
-
-::::
-
-## Contributor Manual
-
-These documents are targeted at authors contributing to the HIP runtime and
-the accompanying host/device compiler.
+If you want to contribute to the HIP Runtime documentation, first review our
+{doc}`/additional_resources/contributing`.
 
 ::::{grid} 1 1 2 2
 :gutter: 1
 
-:::{grid-item-card} Reference
-:::
+:::{grid-item-card} Conceptual
 
-:::{grid-item-card} Background
+- {doc}`/conceptual/hip_rtc`
+- {doc}`/conceptual/programming_manual`
 :::
 
-:::{grid-item-card} How-to Guides
-
-- {doc}`/developer_guide/build`
-
-:::
-
-:::{grid-item-card} Tutorials
-:::
-
-::::
-
-## Legacy Content
-
-Materials listed here don't fit well the new documentation system and will be
-removed once their contents are appropriately covered.
-
-::::{grid} 1 1 2 2
-:gutter: 1
-
-:::{grid-item-card} User Guide
-
-- {doc}`/user_guide/programming_manual`
-- {doc}`/user_guide/hip_rtc`
-- {doc}`/user_guide/faq`
-
-:::
-
-:::{grid-item-card} How to Guides
-
-- {doc}`/how_to_guides/debugging`
+:::{grid-item-card} How-to
 
+- {doc}`/how_to/install`
+- {doc}`/how_to/build`
+- {doc}`/how_to/debugging`
+- {doc}`/how_to/porting`
 :::
 
 :::{grid-item-card} Reference
 
+- {doc}`/.doxygen/docBin/html/index`
+- {doc}`/reference/programming_model`
+- {doc}`/reference/kernel_language`
+- {doc}`/reference/math_api`
+- {doc}`/reference/deprecated_api_list`
 - {doc}`/reference/terms`
-
+- {doc}`/reference/logging`
 :::
 
-:::{grid-item-card} Developer Guide
-
-- {doc}`/developer_guide/logging`
-- {doc}`/developer_guide/contributing`
+:::{grid-item-card} Tutorials
 
+- {doc}`/tutorials/saxpy`
 :::
 
 ::::

docs/tutorials/saxpy.md

@@ -11,7 +11,7 @@ In order to follow this tutorial you will need properly installed drivers and a
 HIP compiler toolchain to compile your code. Because HIP provided by ROCm
 supports compiling and running on Linux and Windows with AMD and NVIDIA GPUs
 alike, the combination of install instructions are more then worth covering as
-part of this tutorial. Please refer to {doc}`/how_to_guides/install` on how to
+part of this tutorial. Please refer to {doc}`/how_to/install` on how to
 install HIP development packages.
 
 ## Heterogenous Programming

include/hip/hip_ext.h

@@ -50,7 +50,7 @@ THE SOFTWARE.
  * @param [in] extra  Pointer to kernel arguments. These are passed directly to the kernel and
  * must be in the memory layout and alignment expected by the kernel.
  * All passed arguments must be naturally aligned according to their type. The memory address of each
- * argument should be a multiple of its size in bytes. Please refer to hip_porting_driver_api.md
+ * argument should be a multiple of its size in bytes. Please refer to porting_driver.md
  * for sample usage.
  * @param [in] startEvent  If non-null, specified event will be updated to track the start time of
  * the kernel launch. The event must be created before calling this API.

include/hip/hip_runtime_api.h

@@ -4984,7 +4984,7 @@ hipError_t hipModuleLoadDataEx(hipModule_t* module, const void* image, unsigned
  * @param [in] extra     Pointer to kernel arguments.   These are passed directly to the kernel and
  * must be in the memory layout and alignment expected by the kernel.
  * All passed arguments must be naturally aligned according to their type. The memory address of each
- * argument should be a multiple of its size in bytes. Please refer to hip_porting_driver_api.md
+ * argument should be a multiple of its size in bytes. Please refer to porting_driver.md
  * for sample usage.
  *
  * Please note, HIP does not support kernel launch with total work items defined in dimension with