cleaning documentation

Author: romdalf

DOCS.md

@@ -1,13 +1,13 @@
-# NetApp Neo CLI (`neoctl`) Documentation
+# NetApp Neo CLI (```neoctl```) Documentation
 
-`neoctl` is the command-line interface for managing NetApp Neo instances and software bundles. It simplifies the deployment, configuration, and lifecycle management of Neo Core and Neo UI components.
+```neoctl``` is the command-line interface for managing NetApp Neo instances and software bundles. It simplifies the deployment, configuration, and lifecycle management of Neo Core and Neo UI components.
 
 ## Prerequisites
 
-Before using `neoctl`, ensure your system meets the requirements:
+Before using ```neoctl```, ensure your system meets the requirements:
 - **Operating System**: Linux (AMD64)
 - **Container Runtime**: Docker or Podman
-- **Utilities**: `cifs-utils` (specifically `mount.cifs`)
+- **Utilities**: ```cifs-utils``` (specifically ```mount.cifs```)
 
 Run the verify command to check your system:
 ```bash
@@ -16,33 +16,33 @@ neoctl verify
 
 ## Global Concepts
 
-- **Configuration**: Stored in `~/.neoctl/`.
-    - `bundle.json`: Stores registry info and available versions.
-    - `config.json`: (Internal use)
-    - `instances.json`: Stores instance configurations.
+- **Configuration**: Stored in ```~/.neoctl/```.
+    - ```bundle.json```: Stores registry info and available versions.
+    - ```config.json```: (Internal use)
+    - ```instances.json```: Stores instance configurations.
 - **Instances**: A named deployment of Neo (Core + UI + DB).
 - **Bundles**: The software images for Neo Core and Neo UI.
 
 ## Commands
 
 ### Global Flags
-- `--help`, `-h`: Show help for command.
+- ```--help```, ```-h```: Show help for command.
 
-### `neoctl version`
+### ```neoctl version```
 Displays the current version of the CLI tool.
 
 ---
 
 ### Bundle Management
 Manage the software versions used for deploying instances.
 
-#### `neoctl bundle get`
+#### ```neoctl bundle get```
 Fetches the latest version information from the configured container registries. This updates your local cache of available versions.
 
-#### `neoctl bundle version`
+#### ```neoctl bundle version```
 Displays the currently configured versions and the cached "recent" versions for Neo Core and Neo UI.
 
-#### `neoctl bundle configure`
+#### ```neoctl bundle configure```
 Sets the specific versions of Neo components to use for new instances.
 
 **Usage:**
@@ -52,8 +52,8 @@ neoctl bundle configure reset
 ```
 
 **Flags:**
-- `--core <string>`: specific version tag for Neo Core.
-- `--ui <string>`: specific version tag for Neo UI.
+- ```--core <string>```: specific version tag for Neo Core.
+- ```--ui <string>```: specific version tag for Neo UI.
 
 **Examples:**
 ```bash
@@ -69,7 +69,7 @@ neoctl bundle configure reset
 ### Instance Management
 Manage the lifecycle of Neo deployments.
 
-#### `neoctl instance configure`
+#### ```neoctl instance configure```
 Creates or updates the configuration for a named instance.
 
 **Usage:**
@@ -78,20 +78,20 @@ neoctl instance configure <name> [flags]
 ```
 
 **Flags:**
-- `--db`: Enable managed database (default true).
-- `--port-core <int>`: Port for Neo Core API (default 8081).
-- `--port-ui <int>`: Port for Neo Console UI (default 8080).
-- `--port-sql <int>`: Port for PostgreSQL (default 5432).
-- `--cpu <string>`: CPU limit (default "4").
-- `--memory <string>`: Memory limit (default "8G").
-- `--gpu`: Enable GPU support (requires NVIDIA runtime).
+- ```--db```: Enable managed database (default true).
+- ```--port-core <int>```: Port for Neo Core API (default 8081).
+- ```--port-ui <int>```: Port for Neo Console UI (default 8080).
+- ```--port-sql <int>```: Port for PostgreSQL (default 5432).
+- ```--cpu <string>```: CPU limit (default "4").
+- ```--memory <string>```: Memory limit (default "8G").
+- ```--gpu```: Enable GPU support (requires NVIDIA runtime).
 
 **Example:**
 ```bash
 neoctl instance configure my-neo --port-ui 8090
 ```
 
-#### `neoctl instance start`
+#### ```neoctl instance start```
 Starts a configured instance. Generates necessary environment and compose files.
 
 **Usage:**
@@ -100,20 +100,20 @@ neoctl instance start <name> [flags]
 ```
 
 **Flags:**
-- `--all`: Start all configured instances.
+- ```--all```: Start all configured instances.
 
-#### `neoctl instance stop`
-Stops a running instance.
+#### ```neoctl instance stop```
+Stops a running instance.   
 
 **Usage:**
 ```bash
 neoctl instance stop <name> [flags]
 ```
 
 **Flags:**
-- `--all`: Stop all configured instances.
+- ```--all```: Stop all configured instances.
 
-#### `neoctl instance delete`
+#### ```neoctl instance delete```
 Stops and removes an instance, deleting its configuration files.
 
 **Usage:**
@@ -122,9 +122,9 @@ neoctl instance delete <name> [flags]
 ```
 
 **Flags:**
-- `--all`: Delete all configured instances.
+- ```--all```: Delete all configured instances.
 
-#### `neoctl instance logs`
+#### ```neoctl instance logs```
 Fetches logs for an instance.
 
 **Usage:**
@@ -133,11 +133,11 @@ neoctl instance logs <name> [flags]
 ```
 
 **Flags:**
-- `--archive`: Save logs for all services (neo, neoui, neodb) into a `.tar.gz` archive.
-- `--all`: Fetch logs for all instances.
+- ```--archive```: Save logs for all services (neo, neoui, neodb) into a `.tar.gz` archive.
+- ```--all```: Fetch logs for all instances.
 
-#### `neoctl instance status`
+#### ```neoctl instance status```
 Lists all configured instances and their current running status (Running, Stopped, Degraded).
 
-#### `neoctl instance show`
+#### ```neoctl instance show```
 Displays the raw JSON configuration of all instances.