# Anywhere {branch} is used, the branch name will be substituted.
# These comments will also be removed.
defaults:
  numbered: False
  maxdepth: 6
root: index
subtrees:

- caption: Installation
  entries:
  - file: install/install
    title: Install HIP
  - file: install/build
    title: Build HIP

- caption: Reference
  entries:
    - file: reference/programming_model
    - file: old/reference/kernel_language
    - file: doxygen/mainpage.md
      title: API library
    - file: reference/deprecated_api_list
      title: Deprecated API list

- caption: How-to
  entries:
  - file: how-to/logging
    title: Logging
  - file: how-to/debugging
    title: Debugging

- caption: Conceptual
  entries:
  - file: understand/programming_model

- caption: Compatibility & support
  entries:
  - url: https://rocm.docs.amd.com/projects/install-on-linux/en/${branch}/reference/system-requirements.html
    title: Linux (GPU & OS)
  - url: https://rocm.docs.amd.com/projects/install-on-windows/en/${branch}/reference/system-requirements.html
    title: Windows (GPU & OS)
  - url: https://rocm.docs.amd.com/projects/install-on-linux/en/${branch}/reference/3rd-partry-support-matrix.html
    title: Third-party
  - url: https://rocm.docs.amd.com/projects/install-on-linux/en/${branch}/reference/user-kernel-space-compat-matrix.html
    title: User/kernel space support
  - url: https://rocm.docs.amd.com/projects/install-on-linux/en/${branch}/reference/docker-image-support-matrix.html
    title: Docker
  - url: https://rocm.docs.amd.com/en/${branch}/about/compatibility/openmp.html
    title: OpenMP

- caption: Contribute
  entries:
  - file: CONTRIBUTING
    title: Contribute to HIP
  - url: https://rocm.docs.amd.com/en/latest/contribute/contributing.html
    title: Contribute to ROCm docs
  - file: license.md