Add mkdocs config (#17)

* Add files via upload

* Add docs prerequisites to devcontainer

* Add instructions to run the docs locally

.devcontainer/post-create.sh

@@ -1,3 +1,7 @@
 dapr uninstall
 dapr init
-pip install --upgrade pip
+pip install --upgrade pip
+pip install mkdocs
+pip install mkdocs-material
+pip install "mkdocs-material[imaging]"
+pip install mkdocs-jupyter

README.md

@@ -83,11 +83,21 @@ Verify you have container instances with `daprio/dapr`, `openzipkin/zipkin`, and
 docker ps
 ```
 
-## Acknowledgments
-Dapr Agents was born out of a desire to explore and learn more about [Dapr](https://dapr.io/) and its potential for building agentic systems. I wanted to understand how to deploy agents as services, manage message communication, and connect various components effectively. Along the way, I looked to several established frameworks for ideas and guidance, which helped shape my thinking and approach:
+## Contributing to the docs
 
-* https://github.com/microsoft/autogen
-* https://github.com/langchain-ai/langchain
-* https://github.com/run-llama/llama_deploy
+### Running the docs locally
 
-While these frameworks provided valuable insights, Dapr Agents is my unique take on how to leverage Dapr for agent-based workflows and systems. It reflects my learning journey and ongoing research in this exciting space.
+1. Install the dependencies
+
+```bash
+pip install mkdocs
+pip install mkdocs-material
+pip install "mkdocs-material[imaging]"
+pip install mkdocs-jupyter
+```
+
+2. Run the docs
+
+```bash
+mkdocs serve
+```

mkdocs.yml

@@ -0,0 +1,145 @@
+# Project information
+site_name: Dapr Agents
+site_url: https://dapr-sandbox.github.io/dapr-agents
+site_author: Dapr maintainers
+site_description: Build autonomous, resilient and observable AI agents with built-in workflow orchestration, security, statefulness and telemetry.
+strict: false
+
+# Repository
+repo_name: dapr-sandbox/dapr-agents
+repo_url: https://github.com/dapr-sandbox/dapr-agents
+edit_uri: edit/main/docs/
+
+# Copyright
+copyright: Copyright © 2024 Dapr maintainers
+
+theme:
+  name: material
+  logo: 'logo-sticker.png'
+  favicon: 'favicon.png'
+  icon:
+    repo: fontawesome/brands/github 
+  palette:
+    # Palette toggle for automatic mode
+    - media: "(prefers-color-scheme)"
+      toggle:
+        icon: material/brightness-auto
+        name: Switch to light mode
+    
+    # Palette toggle for light mode
+    - media: "(prefers-color-scheme: light)"
+      scheme: default
+      primary: indigo
+      accent: deep orange
+      toggle:
+        icon: material/weather-night 
+        name: Switch to dark mode
+    
+    # Palette toggle for dark mode
+    - media: "(prefers-color-scheme: dark)"
+      scheme: slate
+      primary: indigo
+      accent: deep orange
+      toggle:
+        icon: material/weather-sunny
+        name: Switch to light mode
+  features:
+    - content.tabs.link
+    - content.code.annotate
+    - content.code.copy
+    - content.action.edit
+    - content.code.select
+    - content.tooltips
+    - announce.dismiss
+    - navigation.expand
+    - navigation.indexes
+    - navigation.path
+    - navigation.tabs
+    - navigation.instant
+    - navigation.instant.preview
+    - navigation.instant.prefetch
+    - navigation.instant.progress
+    - navigation.sections
+    - navigation.tracking
+    - navigation.top
+    - search.suggest
+    - toc.follow
+
+plugins:
+  - search
+  - mkdocs-jupyter:
+      # ignore_h1_titles: true
+      execute: false
+
+markdown_extensions:
+  - tables
+  - toc:
+      permalink: true
+      title: Page contents
+  - admonition
+  - pymdownx.details
+  - pymdownx.superfences:
+      custom_fences:
+        - name: mermaid
+          class: mermaid
+          format: !!python/name:pymdownx.superfences.fence_code_format
+  - pymdownx.highlight:
+      pygments_lang_class: true
+  - pymdownx.extra
+  - pymdownx.emoji:
+      emoji_index: !!python/name:material.extensions.emoji.twemoji
+      emoji_generator: !!python/name:material.extensions.emoji.to_svg
+  - pymdownx.tabbed:
+      alternate_style: true
+  - attr_list
+  - md_in_html
+
+extra:
+  version:
+    provider: mike
+  analytics:
+    feedback:
+      title: Was this page helpful?
+      ratings:
+        - icon: material/heart
+          name: This page was helpful
+          data: 1
+          note: >-
+            Thanks for your feedback!
+        - icon: material/heart-broken
+          name: This page could be improved
+          data: 0
+          note: >-
+            Thanks for your feedback!
+  social:
+    - icon: fontawesome/brands/github
+      link: https://github.com/dapr-sandbox/dapr-agents
+    - icon: fontawesome/brands/python
+      link: https://pypi.org/project/dapr-agents/
+    - icon: fontawesome/brands/x-twitter
+      link: https://twitter.com/dapr
+
+# https://www.mkdocs.org/user-guide/configuration/#validation
+validation:
+  omitted_files: warn
+  absolute_links: warn
+  unrecognized_links: warn
+
+nav:
+  - Home:
+    - Home: index.md
+    - Why Dapr Agents: home/why.md
+    - Core Principles: home/principles.md
+    - Installation: home/installation.md
+    - Quickstarts:
+      - Quickstarts: home/quickstarts/index.md
+      - LLM Inference Client: home/quickstarts/llm.md
+      - AI Agents: home/quickstarts/agents.md
+      - Dapr Workflows: home/quickstarts/dapr_workflows.md
+      - LLM-based Task Workflows: home/quickstarts/llm_workflows.md
+      - Multi-Agent Workflows: home/quickstarts/agentic_workflows.md
+  - Core Concepts:
+    - Agents: concepts/agents.md
+    - Messaging: concepts/messaging.md
+    - Text Splitter: concepts/text_splitter.md
+    - Arxiv Fetcher: concepts/arxiv_fetcher.md