mkdocs.yml

site_name: Open Chat Studio Documentation
site_url: https://docs.openchatstudio.com
repo_url: https://github.com/dimagi/open-chat-studio-docs
edit_uri: edit/main/docs/
theme:
  name: material
  logo: assets/logo.png
  custom_dir: overrides
  features:
    - header.autohide
    - navigation.expand
    - navigation.footer
    - navigation.indexes
    - navigation.instant
    - navigation.instant.prefetch
    - navigation.instant.progress
    - navigation.prune
    - navigation.sections
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.tracking
    - navigation.top
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow
    - content.action.edit
    - content.action.view
    - content.code.annotate
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
copyright: Copyright © 2024 Dimagi

extra_css:
  - assets/extra.css

markdown_extensions:
  - admonition
  - attr_list
  - def_list
  - md_in_html
  - pymdownx.blocks.caption
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - toc:
      permalink: true

plugins:
- search
- git-revision-date-localized
- redirects:
    redirect_maps:
      'concepts/team/tracing_providers.md': 'concepts/tracing.md'
- macros:
    render_by_default: false
- mkdocstrings:
    enabled: true
    default_handler: python
    handlers:
      python:
        paths: [src]
        options:
          heading_level: 3
          show_root_full_path: false
          show_root_heading: true
          show_signature: true
          show_signature_annotations: true
          show_source: false
          show_symbol_type_heading: true

nav:
  - Home: index.md
  - Tutorials:
      - tutorials/index.md
      - tutorials/first_chatbot.md
      - Configure LLM Providers: tutorials/configure_providers.md      
      - Configure Message Providers: tutorials/configure_msg_providers.md
      - Create & Publish Versions: tutorials/versioning_steps.md
  - How-to Guides:
      - how-to/index.md
      - how-to/workflow_cookbook.md
      - how-to/add_a_knowledge_base.md
      - how-to/deploy_to_different_channels.md
      - how-to/whatsapp_meta_cloud_api.md
      - how-to/global_search.md
      - Filter Tables with Natural Language: how-to/nl_filter.md
      - how-to/setting_up_a_survey.md
      - how-to/assistants_migration.md
      - FAQ: how-to/faq.md
  - Concepts:
      - concepts/index.md

      - Chatbots:
        - concepts/chatbots/index.md
        - concepts/sessions.md
        - concepts/llm.md
        - concepts/participant_data.md
        - concepts/prompt_variables.md
        - concepts/source_material.md
        - concepts/versioning.md
        - concepts/llm_custom_action.md
        - concepts/consent.md
        - concepts/channels.md
        - concepts/events.md
        - concepts/tags.md
        - concepts/tracing.md
        - concepts/tools/index.md
        - Experiments: concepts/experiment/index.md
      - Collections:
        - concepts/collections/index.md
        - concepts/collections/media.md
        - Indexed Collection for RAG: concepts/collections/indexed.md
      - Pipelines:
        - concepts/pipelines/index.md
        - Node Types: concepts/pipelines/nodes.md
        - Router Nodes: concepts/pipelines/router_nodes.md        
        - concepts/pipelines/history.md
        - concepts/pipelines/parallel.md
      - Team:
          - concepts/team/index.md
          - concepts/team/llm_providers.md
          - concepts/team/speech_providers.md
          - concepts/team/authentication_providers.md
          - concepts/team/messaging_providers.md
          - Custom Actions: concepts/team/custom_actions.md
          - User Groups: concepts/team/groups.md
      - Assistants:
          - concepts/assistants.md
      - Evaluations:
        - concepts/evaluations/index.md
        - concepts/evaluations/dataset.md
        - concepts/evaluations/evaluators.md
      - Annotations:
        - concepts/annotations/index.md
        - concepts/annotations/queues.md
        - Annotating: concepts/annotations/annotating.md
  - Tech Hub:
    - tech-hub/index.md
    - Python Node: tech-hub/python_node.md
    - Call External APIs: 
        - tech-hub/external-api-calls/index.md     
        - HTTP Client: tech-hub/external-api-calls/http_client.md
    - Custom Actions:
        - tech-hub/custom_action/index.md
        - Custom Action Health: tech-hub/custom_action/health_custom_action.md
        - Custom Action Testing: tech-hub/custom_action/test_custom_action.md

    - OCS API:
        - api/index.md
        - api/getting_started_with_oauth.md
        - API Access: tech-hub/api_access.md  
  - Chat Widget:
    - chat_widget/index.md
    - chat_widget/reference.md
    - chat_widget/styling.md
    - chat_widget/changelog.md           
  - Changelog: changelog.md

watch:
- src/python_node

extra_javascript:
  - path: https://unpkg.com/open-chat-studio-widget@0.6.0/dist/open-chat-studio-widget/open-chat-studio-widget.esm.js
# Use this for testing widget changes
#  - path: assets/build/open-chat-studio-widget.esm.js
    type: module
    async: true
  - path: ./assets/javascript/widget.js