mkdocs.yml

site_name: "" # already part of the logo
site_description: "Ask A Question Documentation"
site_url: https://docs.ask-a-question.com/
repo_url: https://github.com/IDinsight/ask-a-question
copyright: "© 2024 IDinsight"
extra:
  analytics:
    provider: google
    property: G-K07FFTMFTN
  generator: false
  social:
    - icon: material/shield-lock
      link: https://www.idinsight.org/about/privacy-policy/
      name: Privacy Policy
  version:
    provider: mike
    alias: true
    default: latest

nav:
  - Home:
      - "": index.md
      - Usage: usage.md
      - Roadmap: roadmap.md

  - Try it ↗︎: https://app.ask-a-question.com

  - Latest Updates:
      - blog/index.md

  - Components:
      - components/index.md
      - User-facing components:
          - Admin App:
              - components/admin-app/index.md
              - Question Answering Contents: components/admin-app/question-answering/index.md
              - Urgency Detection Rules: components/admin-app/urgency-rules/index.md
              - Dashboard: components/admin-app/dashboard/index.md
          - Question-Answering Service:
              - components/qa-service/index.md
              - Search: components/qa-service/search.md
              - Voice Search: components/qa-service/voice-search.md
              - Response Feedback: components/qa-service/response-feedback.md
              - Content Feedback: components/qa-service/content-feedback.md
          - Urgency Detection Service:
              - components/urgency-detection/index.md
      - Internal components:
          - LLM Proxy Server:
              - components/litellm-proxy/index.md
          - Hugging Face Embeddings:
              - components/huggingface-embeddings/index.md
              - How to use: components/huggingface-embeddings/how-to-use.md
          - Voice Service:
              - components/voice-service/index.md
              - In-house models: components/voice-service/in-house-models.md
              - External APIs: components/voice-service/external-apis.md

  - Integrations:
      - integrations/index.md
      - Chat Managers:
          - Typebot: integrations/chat_managers/typebot.md
          - Botpress: integrations/chat_managers/botpress_v12.md
          - Turn.io: integrations/chat_managers/turn.io/turn.md
          - Glific: integrations/chat_managers/glific/glific.md

  - Deploy:
      - Quick setup with Docker Compose: deployment/quick-setup.md
      - Architecture: deployment/architecture.md
      - Configuring AAQ: deployment/config-options.md

  - Contribute:
      - Guidelines: develop/contributing.md
      - Setup: develop/setup.md
      - Testing:
          - Backend Tests: develop/testing/core-backend-testing.md
          - In-house Speech Service Tests: develop/testing/speech-service-testing.md
      - Validation: develop/validation.md

  - Contact us:
      - Team: contact_us.md

  - API docs ↗︎: https://app.ask-a-question.com/api/docs

# Themes and extensions
theme:
  name: material
  logo: images/logo-light.png
  favicon: images/favicon.png
  font:
    text: "Inter"
    code: "Roboto Mono"
  palette:
    - scheme: slate # Palette toggle for dark mode
      primary: custom
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
    - scheme: default # Palette toggle for light mode
      primary: custom
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - content.code.annotate
    - content.code.copy
    - navigation.sections
    - navigation.indexes
    - navigation.top

  icon:
    admonition:
      note: material/alert-circle
    annotation: material/help-circle

extra_css:
  - stylesheets/extra.css

markdown_extensions:
  - tables
  - admonition
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tasklist:
      custom_checkbox: true
  - attr_list
  - md_in_html
  - def_list
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - toc:
      title: On this page
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences

plugins:
  - glightbox
  - search
  - blog:
      post_excerpt: required
  - open-in-new-tab