[DOCS]

docs/index.md

@@ -1,81 +1,267 @@
-<div align="center">
-  <p>
-    <a align="center" href="" target="_blank">
-      <img
-        width="850"
-        src="https://github.com/kyegomez/zeta/raw/master/images/zeta.png"
-      >
-    </a>
-  </p>
-</div>
+# Zeta 
 
-## 👋 Hello
+You can install `zeta` with pip in a
+[**Python>=3.10**](https://www.python.org/) environment.
 
-zeta provides you with all the modular lego blocks you need to build bleeding edge AI models as fast as possible.
+## Prerequisites
 
+Before you begin, ensure you have the following installed:
 
-## 💻 Install
+- Python 3.10 or higher: [Download Python](https://www.python.org/)
+- pip (specific version recommended): `pip >= 21.0`
+- git (for cloning the repository): [Download Git](https://git-scm.com/)
 
-You can install `zeta` with pip in a
-[**Python>=3.8**](https://www.python.org/) environment.
+## Installation Options
+
+=== "pip (Recommended)"
+
+    #### Headless Installation
+
+    The headless installation of `zeta` is designed for environments where graphical user interfaces (GUI) are not needed, making it more lightweight and suitable for server-side applications.
+
+    ```bash
+    pip install zetascale
+    ```
+
+=== "Development Installation"
+
+    === "Using virtualenv"
+
+        1. **Clone the repository and navigate to the root directory:**
+
+            ```bash
+            git clone https://github.com/kyegomez/zeta.git
+            cd zeta
+            ```
+
+        2. **Setup Python environment and activate it:**
+
+            ```bash
+            python3 -m venv venv
+            source venv/bin/activate
+            pip install --upgrade pip
+            ```
+
+        3. **Install zeta:**
+
+            - Headless install:
+
+                ```bash
+                pip install -e .
+                ```
+
+            - Desktop install:
+
+                ```bash
+                pip install -e .[desktop]
+                ```
+
+    === "Using Anaconda"
+
+        1. **Create and activate an Anaconda environment:**
+
+            ```bash
+            conda create -n zeta python=3.10
+            conda activate zeta
+            ```
+
+        2. **Clone the repository and navigate to the root directory:**
+
+            ```bash
+            git clone https://github.com/kyegomez/zeta.git
+            cd zeta
+            ```
+
+        3. **Install zeta:**
+
+            - Headless install:
+
+                ```bash
+                pip install -e .
+                ```
+
+            - Desktop install:
 
-!!! example "pip install (recommended)"
+                ```bash
+                pip install -e .[desktop]
+                ```
 
-    === "headless"
-        The headless installation of `zeta` is designed for environments where graphical user interfaces (GUI) are not needed, making it more lightweight and suitable for server-side applications.
+    === "Using Poetry"
+
+        1. **Clone the repository and navigate to the root directory:**
+
+            ```bash
+            git clone https://github.com/kyegomez/zeta.git
+            cd zeta
+            ```
+
+        2. **Setup Python environment and activate it:**
+
+            ```bash
+            poetry env use python3.10
+            poetry shell
+            ```
+
+        3. **Install zeta:**
+
+            - Headless install:
+
+                ```bash
+                poetry install
+                ```
+
+            - Desktop install:
+
+                ```bash
+                poetry install --extras "desktop"
+                ```
+<!-- 
+=== "Using Docker"
+
+    Docker is an excellent option for creating isolated and reproducible environments, suitable for both development and production.
+
+    1. **Pull the Docker image:**
 
         ```bash
-        pip install zetascale
+        docker pull kyegomez/zeta
         ```
 
+    2. **Run the Docker container:**
 
-!!! example "git clone (for development)"
+        ```bash
+        docker run -it --rm kyegomez/zeta
+        ```
 
-    === "virtualenv"
+    3. **Build and run a custom Docker image:**
+
+        ```dockerfile
+        # Dockerfile
+        FROM python:3.10-slim
+
+        # Set up environment
+        WORKDIR /app
+        COPY . /app
+
+        # Install dependencies
+        RUN pip install --upgrade pip && \
+            pip install -e .
+
+        CMD ["python", "your_script.py"]
+        ```
 
         ```bash
-        # clone repository and navigate to root directory
-        git clone https://github.com/kyegomez/zeta.git
-        cd zeta
+        # Build and run the Docker image
+        docker build -t zeta-custom .
+        docker run -it --rm zeta-custom
+        ```
 
-        # setup python environment and activate it
-        python3 -m venv venv
-        source venv/bin/activate
-        pip install --upgrade pip
+=== "Using Kubernetes"
 
-        # headless install
-        pip install -e "."
+    Kubernetes provides an automated way to deploy, scale, and manage containerized applications.
 
-        # desktop install
-        pip install -e ".[desktop]"
+    1. **Create a Deployment YAML file:**
+
+        ```yaml
+        apiVersion: apps/v1
+        kind: Deployment
+        metadata:
+          name: zeta-deployment
+        spec:
+          replicas: 3
+          selector:
+            matchLabels:
+              app: zeta
+          template:
+            metadata:
+              labels:
+                app: zeta
+            spec:
+              containers:
+              - name: zeta
+                image: kyegomez/zeta
+                ports:
+                - containerPort: 8080
+        ```
+
+    2. **Apply the Deployment:**
+
+        ```bash
+        kubectl apply -f deployment.yaml
         ```
 
-    === "poetry"
+    3. **Expose the Deployment:**
 
         ```bash
-        # clone repository and navigate to root directory
-        git clone https://github.com/kyegomez/zeta.git
-        cd zeta
+        kubectl expose deployment zeta-deployment --type=LoadBalancer --name=zeta-service
+        ``` -->
+<!-- 
+=== "CI/CD Pipelines"
 
-        # setup python environment and activate it
-        poetry env use python3.10
-        poetry shell
+    Integrating zeta into your CI/CD pipeline ensures automated testing and deployment.
 
-        # headless install
-        poetry install
+    #### Using GitHub Actions
 
-        # desktop install
-        poetry install --extras "desktop"
-        ```
+    ```yaml
+    # .github/workflows/ci.yml
+    name: CI
 
+    on:
+      push:
+        branches: [ main ]
+      pull_request:
+        branches: [ main ]
 
-## Documentation
+    jobs:
+      build:
 
-[Learn more about zeta →](zeta/)
+        runs-on: ubuntu-latest
 
+        steps:
+        - uses: actions/checkout@v2
+        - name: Set up Python
+          uses: actions/setup-python@v2
+          with:
+            python-version: 3.10
+        - name: Install dependencies
+          run: |
+            python -m venv venv
+            source venv/bin/activate
+            pip install --upgrade pip
+            pip install -e .
+        - name: Run tests
+          run: |
+            source venv/bin/activate
+            pytest
+    ```
 
-## Examples
+    #### Using Jenkins
 
-Check out zeta examples for building agents, data retrieval, and more.
+    ```groovy
+    pipeline {
+        agent any
 
-[Checkout zeta examples →](examples/)
+        stages {
+            stage('Clone repository') {
+                steps {
+                    git 'https://github.com/kyegomez/zeta.git'
+                }
+            }
+            stage('Setup Python') {
+                steps {
+                    sh 'python3 -m venv venv'
+                    sh 'source venv/bin/activate && pip install --upgrade pip'
+                }
+            }
+            stage('Install dependencies') {
+                steps {
+                    sh 'source venv/bin/activate && pip install -e .'
+                }
+            }
+            stage('Run tests') {
+                steps {
+                    sh 'source venv/bin/activate && pytest'
+                }
+            }
+        }
+    }
+    ``` -->