Fix errors and improve Doc (#143)

* Fix link issues and add icons

* Improve Doc

* fix test

* making minor modifications to shuguangs' doc changes

---------

Co-authored-by: Salman Paracha <salmanparacha@MacBook-Pro-261.local>
Co-authored-by: Adil Hafeez <adil@katanemo.com>

docs/source/get_started/includes/quickstart.yaml

@@ -1,47 +1,44 @@
-version: "0.1-beta"
+version: v0.1
+
 listen:
-  address: 127.0.0.1 | 0.0.0.0
-  port_value: 8080 #If you configure port 443, you'll need to update the listener with tls_certificates
-
-system_prompt: |
-  You are a network assistant that just offers facts; not advice on manufacturers or purchasing decisions.
+  address: 0.0.0.0 # or 127.0.0.1
+  port: 10000
+  # Defines how Arch should parse the content from application/json or text/pain Content-type in the http request
+  message_format: huggingface
 
+# Centralized way to manage LLMs, manage keys, retry logic, failover and limits in a central way
 llm_providers:
-  - name: "OpenAI"
-    provider: "openai"
+  - name: OpenAI
+    provider: openai
     access_key: OPENAI_API_KEY
     model: gpt-4o
+    default: true
     stream: true
 
+# default system prompt used by all prompt targets
+system_prompt: You are a network assistant that just offers facts; not advice on manufacturers or purchasing decisions.
+
 prompt_targets:
   - name: reboot_devices
-    description: >
-      This prompt target handles user requests to reboot devices.
-      It ensures that when users request to reboot specific devices or device groups, the system processes the reboot commands accurately.
-
-      **Examples of user prompts:**
-
-      - "Please reboot device 12345."
-      - "Restart all devices in tenant group tenant-XYZ
-      - "I need to reboot devices A, B, and C."
+    description: Reboot specific devices or device groups
 
     path: /agent/device_reboot
     parameters:
-      - name: "device_ids"
-        type: list  # Options: integer | float | list | dictionary | set
-        description: "A list of device identifiers (IDs) to reboot."
+      - name: device_ids
+        type: list
+        description: A list of device identifiers (IDs) to reboot.
         required: false
-      - name: "device_group"
-        type: string  # Options: string | integer | float | list | dictionary | set
-        description: "The name of the device group to reboot."
+      - name: device_group
+        type: str
+        description: The name of the device group to reboot
         required: false
 
 # Arch creates a round-robin load balancing between different endpoints, managed via the cluster subsystem.
 endpoints:
   app_server:
     # value could be ip address or a hostname with port
-    # this could also be a list of endpoints for load balancing for example endpoint: [ ip1:port, ip2:port ]
-    endpoint: "127.0.0.1:80"
+    # this could also be a list of endpoints for load balancing
+    # for example endpoint: [ ip1:port, ip2:port ]
+    endpoint: 127.0.0.1:80
     # max time to wait for a connection to be established
     connect_timeout: 0.005s
-  version: "0.1-beta"

docs/source/get_started/overview.rst

@@ -1,3 +1,6 @@
+.. _overview:
+
+
 Overview
 ============
 Welcome to Arch, the intelligent prompt gateway designed to help developers build **fast**, **secure**, and **personalized** generative AI apps at ANY scale.
@@ -12,17 +15,17 @@ This section introduces you to Arch and helps you get set up quickly:
 
 .. grid:: 3
 
-    .. grid-item-card:: Overview
+    .. grid-item-card:: :octicon:`apps` Overview
         :link: overview.html
 
         Overview of Arch and Doc navigation
 
-    .. grid-item-card:: Intro to Arch
+    .. grid-item-card:: :octicon:`book` Intro to Arch
         :link: intro_to_arch.html
 
         Explore Arch's features and developer workflow
 
-    .. grid-item-card:: Quickstart
+    .. grid-item-card:: :octicon:`rocket` Quickstart
         :link: quickstart.html
 
         Learn how to quickly set up and integrate
@@ -35,18 +38,18 @@ Deep dive into essential ideas and mechanisms behind Arch:
 
 .. grid:: 3
 
-    .. grid-item-card:: Tech Overview
-        :link: ../Concepts/tech_overview/tech_overview.html
+    .. grid-item-card:: :octicon:`package` Tech Overview
+        :link: ../concepts/tech_overview/tech_overview.html
 
         Learn about the technology stack
 
-    .. grid-item-card:: LLM Provider
-        :link: ../Concepts/llm_provider.html
+    .. grid-item-card:: :octicon:`webhook` LLM Provider
+        :link: ../concepts/llm_provider.html
 
         Explore Arch’s LLM integration options
 
-    .. grid-item-card:: Targets
-        :link: ../Concepts/prompt_target.html
+    .. grid-item-card:: :octicon:`workflow` Prompt Target
+        :link: ../concepts/prompt_target.html
 
         Understand how Arch handles prompts
 
@@ -57,18 +60,18 @@ Step-by-step tutorials for practical Arch use cases and scenarios:
 
 .. grid:: 3
 
-    .. grid-item-card:: Prompt Guard
-        :link: ../guides/tech_overview/tech_overview.html
+    .. grid-item-card:: :octicon:`shield-check` Prompt Guard
+        :link: ../guides/prompt_guard.html
 
         Instructions on securing and validating prompts
 
-    .. grid-item-card:: Function Calling
+    .. grid-item-card:: :octicon:`code-square` Function Calling
         :link: ../guides/function_calling.html
 
         A guide to effective function calling
 
-    .. grid-item-card:: Observability
-        :link: ../guides/prompt_target.html
+    .. grid-item-card:: :octicon:`issue-opened` Observability
+        :link: ../guides/observability/observability.html
 
         Learn to monitor and troubleshoot Arch
 
@@ -80,12 +83,12 @@ For developers extending and customizing Arch for specialized needs:
 
 .. grid:: 2
 
-    .. grid-item-card:: Agentic Workflow
+    .. grid-item-card:: :octicon:`dependabot` Agentic Workflow
         :link: ../build_with_arch/agent.html
 
         Discover how to create and manage custom agents within Arch
 
-    .. grid-item-card:: RAG Application
+    .. grid-item-card:: :octicon:`stack` RAG Application
         :link: ../build_with_arch/rag.html
 
         Integrate RAG for knowledge-driven responses

docs/source/get_started/quickstart.rst

@@ -77,7 +77,7 @@ Next Steps
 
 Congratulations! You've successfully set up Arch and made your first prompt-based request. To further enhance your GenAI applications, explore the following resources:
 
-- Full Documentation: Comprehensive guides and references.
+- :ref:`Full Documentation <overview>`: Comprehensive guides and references.
 - `GitHub Repository <https://github.com/katanemo/arch>`_: Access the source code, contribute, and track updates.
 - `Support <https://github.com/katanemo/arch#contact>`_: Get help and connect with the Arch community .