mkdocs.yaml

site_name: "llamabot"
site_url: https://ericmjl.github.io/llamabot

docs_dir: docs/

# For more configuration on the theme, see https://squidfunk.github.io/mkdocs-material/setup/changing-the-colors/
theme:
  name: material
  icon:
    logo: "fontawesome/solid/book"
  features:
    - instant
    - tabs
    - content.code.copy
  language: en

# We customize the navigation by hand to control the order
# in which pages show up.

nav:
  - Home: index.md
  - Getting Started:
    - "Which Bot Should I Use?": getting-started/which-bot.md
  - How-To Guides:
    - "Build an LLM-Powered CLI": how-to/cli-powered-by-llm.md
    - "Generate Blog Banner Images": how-to/generate-blog-banner-images.md
    - "Process Receipts with LLM Agents": how-to/receipt-processing.md
    - "Build a Data Analysis Chatbot": how-to/data-analysis-agentbot.md
    - "AgentBot with MCP tools": how-to/agent-mcp-tools.md
  - Tutorials:
    - "SimpleBot Tutorial": tutorials/simplebot.md
    - "StructuredBot Tutorial": tutorials/structuredbot.md
    - "ToolBot Tutorial": tutorials/toolbot.md
    - "AgentBot Tutorial": tutorials/agentbot.md
    - "QueryBot Tutorial": tutorials/querybot.md
    - "Using Ollama": tutorials/ollama.md
    - "Working with Prompts": tutorials/prompts.md
    - "Recording Prompts": tutorials/recording_prompts.md
    - Chat UI:
      - "SimpleBot and ChatBot": tutorials/chat-ui/simplebot-and-chatbot.md
      - "QueryBot Chat UI": tutorials/chat-ui/querybot.md
  - Reference:
    - Bots:
      - "SimpleBot": reference/bots/simplebot.md
      - "StructuredBot": reference/bots/structuredbot.md
      - "ToolBot": reference/bots/toolbot.md
      - "AgentBot": reference/bots/agentbot.md
      - "QueryBot": reference/bots/querybot.md
      - "ImageBot": reference/bots/imagebot.md
    - Components:
      - "Messages": reference/components/messages.md
      - "Tools": reference/components/tools.md
      - "DocStore": reference/components/docstore.md
      - "Chat Memory": reference/components/chat_memory.md
    - "Async streaming": reference/streaming_async.md
    - "SSE streaming": reference/sse.md
  - CLI:
    - "LlamaBot CLI": cli/llamabot.md
    - "Git Commands": cli/git.md
    - "Docs Server": cli/docs.md
    - "Repository Commands": cli/repo.md
    - "Blog Commands": cli/blog.md
    - "Notebook Commands": cli/notebook.md
    - "Python Commands": cli/python.md
    - "Log Viewer": cli/log-viewer.md
    - "MCP Server": cli/mcp.md
  - Design & Explanation:
    - "High-Level Design (HLD)": high-level-design.md
    - "SimpleBot":
      - "LLD": designs/simplebot/LLD.md
      - "EARS": designs/simplebot/simplebot-EARS.md
    - "StructuredBot":
      - "LLD": designs/structuredbot/LLD.md
      - "EARS": designs/structuredbot/structuredbot-EARS.md
    - "ToolBot":
      - "LLD": designs/toolbot/LLD.md
      - "EARS": designs/toolbot/toolbot-EARS.md
    - "QueryBot (RAG)":
      - "LLD": designs/querybot/LLD.md
      - "EARS": designs/querybot/querybot-EARS.md
    - "AgentBot reference graph":
      - "LLD": designs/agentbot/LLD.md
      - "EARS": designs/agentbot/reference-graph-EARS.md
      - "Redirect (old location)": design/agentbot_pocketflow_graph.md
    - "Unified Chat Memory": design/unified_chat_memory.md
    - "Log Viewer": design/log_viewer.md
    - "Observability": design/observability.md
    - "Agents Build Own Tools": design/agents-build-own-tools.md
  - Contributing:
    - "Setup Guide": contributing/setup.md

hooks:
  - docs/hooks.py

plugins:
  - search
  - mknotebooks:
      execute: false
      write_markdown: true
      allow_errors: false
      timeout: 1200
      binder: true
      binder_service_name: "gh"
      binder_branch: "master"
      binder_ui: "lab"

# Taken from here: https://squidfunk.github.io/mkdocs-material/extensions/codehilite/
markdown_extensions:
  - codehilite
  - admonition
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
  - markdown.extensions.attr_list

extra_css:
  - apidocs.css

extra_javascript:
  - https://unpkg.com/mermaid@10/dist/mermaid.min.js
  - config.js

repo_name: "ericmjl/llamabot"
repo_url: "https://github.com/ericmjl/llamabot"

extra:
  social:
    - icon: "fontawesome/brands/github"
      link: "https://github.com/ericmjl"

    - icon: "fontawesome/brands/twitter"
      link: "https://twitter.com/ericmjl"

    - icon: "fontawesome/brands/linkedin"
      link: "https://linkedin.com/in/ericmjl"