Merge pull request #27 from ROCm/dev/bhatturu/docs-updates

Cherrypicking docs updates to release branch

Author: enricoschiattarella

README.md

@@ -1,5 +1,5 @@
 # Overview
-ROCm Container Toolkit offers tools to streamline the use of AMD GPUs with containers. The toolkit includes the following packages.
+AMD Container Toolkit offers tools to streamline the use of AMD GPUs with containers. The toolkit includes the following packages.
 - ```amd-container-runtime``` - The AMD Container Runtime
 -  ```amd-ctk``` - The AMD Container Toolkit CLI
 

docs/container-runtime/quick-start-guide.rst

@@ -3,6 +3,17 @@ Quick Start Guide
 
 This section provides a step-by-step guide to install the AMD Container Toolkit and configure your system for Docker-based GPU container workloads. The steps below are tailored for ease of use, production-readiness, and ensuring compatibility across AMD Instinct GPU-enabled systems.
 
+Prerequisites
+-------------
+
+Before installing the AMD Container Toolkit, ensure the following dependencies are installed:
+
+1. **jq** - Required during uninstallation to parse configuration settings cleanly.
+
+   .. code-block:: bash
+
+      sudo apt-get install jq
+
 Step 1: Install System Prerequisites
 ------------------------------------
 - Update your system:
@@ -109,3 +120,35 @@ Step 5: Configure Docker Runtime for AMD GPUs
    sudo systemctl restart docker
 
 This configuration ensures that Docker is aware of the AMD container runtime and is able to support GPU-accelerated workloads using AMD Instinct devices.
+
+Uninstallation Guide
+--------------------
+
+To remove the `amd-container-toolkit`, you must have `jq` installed. The uninstallation script relies on it to parse configuration files.
+
+.. code-block:: bash
+
+   sudo apt-get install jq
+
+Then proceed with the removal:
+
+.. code-block:: bash
+
+   sudo apt-get remove --purge amd-container-toolkit
+
+If you encounter issues, inspect the logs:
+
+.. code-block:: bash
+
+   sudo journalctl -u apt
+
+   sudo tail -f /var/log/amd-container-runtime.log
+
+
+If you continue to face errors, you may need to force the removal:
+
+.. code-block:: bash
+
+   sudo dpkg --remove --force-all amd-container-toolkit
+
+   sudo apt-get autoremove

docs/index.md

@@ -1,10 +1,10 @@
 ---
 myst:
   html_meta:
-    "description": "AMD Container Runtime documentation"
+    "description": "AMD Container Toolkit documentation"
     "keywords": "AMD, ROCm, Container Runtime, GPU, HPC, Machine Learning"
 ---
 
-# AMD ROCm Container Runtime Documentation
+# AMD Container Toolkit Documentation
 
-This documentation site provides information about the AMD ROCm Container Runtime, which is a set of tools and libraries for running GPU-accelerated applications in containers. The ROCm platform is designed to enable high-performance computing (HPC) and machine learning workloads on AMD GPUs.
+This documentation site provides information about the AMD Container Toolkit, which is a set of tools and libraries for running GPU-accelerated applications in containers. The ROCm platform is designed to enable high-performance computing (HPC) and machine learning workloads on AMD GPUs.

docs/sphinx/_toc.yml.in

@@ -3,7 +3,7 @@ subtrees:
   - caption: Tools
     entries:
     - file: container-runtime/index.rst
-      title: Container Runtime
+      title: AMD Container Toolkit
       subtrees:
       - entries:
         - file: container-runtime/overview.rst