Split and Refactor Documentation (#128)

---
Signed-off-by: Kartik Nema <kartnema@qti.qualcomm.com>

Author: kartnema

docs/Doxyfile

@@ -864,7 +864,7 @@ WARN_LOGFILE           =
 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
 # Note: If this tag is empty the current directory is searched.
 
-INPUT                  = docs/README.md docs/HOW-TO.md docs/EXTENSIONS.md docs/FEATURES.md docs/REQUESTS.md modula/Common/Include/ Core/Modula/Components/Include/ modula/CoreModules/Include/ client/APIs/Include client/Comm/Socket/Include resource-tuner/extensions/Include resource-tuner/core/Include resource-tuner/init/Include resource-tuner/core/Server/Include resource-tuner/signals/Include docs/Examples/
+INPUT                  = docs/README.md docs/UserGuide modula/Common/Include/ Core/Modula/Components/Include/ modula/CoreModules/Include/ client/APIs/Include client/Comm/Socket/Include resource-tuner/extensions/Include resource-tuner/core/Include resource-tuner/init/Include resource-tuner/core/Server/Include resource-tuner/signals/Include docs/Examples/
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
@@ -920,6 +920,7 @@ FILE_PATTERNS          = *.c \
                          *.phtml \
                          *.inc \
                          *.m \
+                         *.md \
                          *.markdown \
                          *.mm \
                          *.dox \
@@ -1004,7 +1005,7 @@ EXAMPLE_RECURSIVE      = NO
 # that contain images that are to be included in the documentation (see the
 # \image command).
 
-IMAGE_PATH             = docs/images
+IMAGE_PATH             = docs/Images/
 
 # The INPUT_FILTER tag can be used to specify a program that doxygen should
 # invoke to filter for each input file. Doxygen will invoke the filter program

docs/images/design_resource_tuner.png docs/Images/design_resource_tuner.pngdocs/images/design_resource_tuner.png renamed to docs/Images/design_resource_tuner.png

@@ -63,23 +63,22 @@ option(BUILD_CLI "CLI" OFF)
 ## Project Structure
 
 ```text
-/
-├── Client
-├── Server                 # Defines the Server Communication Endpoint and other Common Server-Side Utils
-├── Resource Tuner
-│   ├── Core
-│   │   ├── Framework      # Core Resource Provisioning Request Flow Logic
-│   │   ├── Modula         # Common Utilities and Components used across Resource Tuner Modules
-│   ├── Signals            # Optional Module, exposes Signal Tuning / Relay APIs
-├── Contextual Classifier
-├── CLI                    # Exposes the Client Facing APIs, and Defines the Client Communication Endpoint
-├── Configs                # Resources Config, Properties Config, Init Config, Signal Configs, Ext Feature Configs
-├── Tests                  # Unit and System Wide Tests
-└── Docs                   # Documentation
+.
+├── client
+├── configs
+├── contextual-classifier
+├── debian
+├── docs
+├── extensions
+├── modula
+├── public_headers
+└── resource-tuner
 ```
 
+
 ---
 
+
 <div style="page-break-after: always;"></div>
 
 # Userspace Resource Manager Key Points

docs/README.md

@@ -0,0 +1,87 @@
+\page client_cli Interacting via Client CLI
+
+# Client CLI
+Resource-tuner provides a minimal CLI to interact with the server. This is provided to help with development and debugging purposes.
+
+## Usage Examples
+
+### 1. Send a Tune Request
+```bash
+/usr/bin/urmCli --tune --duration <> --priority <> --num <> --res <>
+```
+Where:
+- `duration`: Duration in milliseconds for the tune request
+- `priority`: Priority level for the tune request (HIGH: 0 or LOW: 1)
+- `num`: Number of resources
+- `res`: List of resource ResCode, ResInfo (optional) and Values to be tuned as part of this request
+
+Example:
+```bash
+# Single Resource in a Request
+/usr/bin/urmCli --tune --duration 5000 --priority 0 --num 1 --res "65536:700"
+
+# Multiple Resources in single Request
+/usr/bin/urmCli --tune --duration 4400 --priority 1 --num 2 --res "0x80030000:700,0x80040001:155667"
+
+# Multi-Valued Resource
+/usr/bin/urmCli --tune --duration 9500 --priority 0 --num 1 --res "0x00090002:0,0,1,3,5"
+
+# Specifying ResInfo (useful for Core and Cluster type Resources)
+/usr/bin/urmCli --tune --duration 5000 --priority 0 --num 1 --res "0x00040000#0x00000100:1620438"
+
+# Everything at once
+/usr/bin/urmCli --tune --duration 6500 --priority 0 --num 2 --res "0x00030000:800;0x00040011#0x00000101:50000,100000"
+```
+
+### 2. Send an Untune Request
+```bash
+/usr/bin/urmCli --untune --handle <>
+```
+Where:
+- `handle`: Handle of the previously issued tune request, which needs to be untuned
+
+Example:
+```bash
+/usr/bin/urmCli --untune --handle 50
+```
+
+### 3. Send a Retune Request
+```bash
+/usr/bin/urmCli --retune --handle <> --duration <>
+```
+Where:
+- `handle`: Handle of the previously issued tune request, which needs to be retuned
+- `duration`: The new duration in milliseconds for the tune request
+
+Example:
+```bash
+/usr/bin/urmCli --retune --handle 7 --duration 8000
+```
+
+### 4. Send a getProp Request
+
+```bash
+/usr/bin/urmCli --getProp --key <>
+```
+Where:
+- `key`: The Prop name of which the corresponding value needs to be fetched
+
+Example:
+```bash
+/usr/bin/urmCli --getProp --key "urm.logging.level"
+```
+
+### 5. Send a tuneSignal Request
+
+```bash
+/usr/bin/urmCli --signal --scode <>
+```
+Where:
+- `key`: The Prop name of which the corresponding value needs to be fetched
+
+Example:
+```bash
+/usr/bin/urmCli --signal --scode "0x00fe0ab1"
+```
+
+<div style="page-break-after: always;"></div>

docs/UserGuide/CLIENT-CLI.md

@@ -1,4 +1,4 @@
-\page extensions Extension Interface Guide
+\page extensions_usage Extension Interface Guide
 
 Refer Plugin.cpp in Examples section, for basic code-guidance.