Add docs, improve readme, add dark logo

Author: leomariga

.github/workflows/deploy-docs.yml

@@ -0,0 +1,63 @@
+name: Deploy Documentation to GitHub Pages
+
+on:
+  # Runs on pushes targeting the main branch
+  push:
+    branches: ["main"]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  # Build job
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e .
+          pip install mkdocs-material>=9.6.21 mkdocstrings[python]>=0.30.1 pymdown-extensions>=10.0
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+
+      - name: Build with MkDocs
+        run: mkdocs build --clean --strict
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: ./site
+
+  # Deployment job
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

CONTRIBUTING.md

@@ -8,6 +8,66 @@ We love your input! We want to make contributing as easy and transparent as poss
 - Proposing new features
 - Becoming a maintainer
 
+## Development Setup
+
+This project uses [uv](https://docs.astral.sh/uv/) for fast, reliable dependency management.
+
+### Prerequisites
+
+Install uv if you haven't already:
+
+```bash
+pip install uv
+```
+
+Or follow the [official installation guide](https://docs.astral.sh/uv/getting-started/installation/).
+
+### Setting Up Your Development Environment
+
+1. **Fork and clone the repository:**
+
+```bash
+git clone https://github.com/YOUR_USERNAME/ProactiveAgent.git
+cd ProactiveAgent
+```
+
+2. **Install dependencies:**
+
+```bash
+# Install all dependencies including dev tools
+uv sync --dev
+```
+
+This will:
+- Create a virtual environment automatically
+- Install all project dependencies from `uv.lock`
+- Install development dependencies (linters, formatters, testing tools)
+
+3. **Run examples or tests:**
+
+```bash
+# Run any script using uv
+uv run python examples/minimal_chat.py
+
+# Or activate the virtual environment
+source .venv/bin/activate  # On Windows: .venv\Scripts\activate
+python examples/minimal_chat.py
+```
+
+### Development Dependencies
+
+The `--dev` flag installs additional tools for development:
+- Code formatters and linters
+- Testing frameworks
+- Documentation generators
+- Any other development utilities
+
+To see all installed dependencies:
+
+```bash
+uv pip list
+```
+
 ## We develop with GitHub
 We use GitHub to host code, track issues and feature requests, and accept pull requests.
 

README.md

@@ -1,8 +1,11 @@
-# ProactiveAgent
-
 <div align="center">
+<picture>
+  <source media="(prefers-color-scheme: dark)" srcset="docs/logo_b.png" width="400">
+  <source media="(prefers-color-scheme: light)" srcset="docs/logo.png" width="400">
+  <img alt="ProactiveAgent logo." src="docs/logo.png" width="400">
+</picture>
 
-<img src="docs/logo.png" alt="ProactiveAgent Logo" width="400"/>
+<!-- <img src="docs/logo.png" alt="ProactiveAgent Logo" width="400"/> -->
 
 **Time-awareness for your AI Agent**
 
@@ -244,7 +247,15 @@ agent.update_config({
 
 ## Contributing
 
-We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details.
+We welcome contributions! This project uses [uv](https://docs.astral.sh/uv/) for dependency management.
+
+**Quick setup:**
+```bash
+pip install uv
+uv sync --dev  # Install dependencies including dev tools
+```
+
+Please see our [Contributing Guide](CONTRIBUTING.md) for detailed instructions.
 
 ## License