mkdocs.yml

site_name: Tryx
site_description: Rust-powered Python SDK for event-driven WhatsApp automation
site_author: krypton-byte
site_url: https://krypton-byte.github.io/tryx/
repo_url: https://github.com/krypton-byte/tryx
repo_name: krypton-byte/tryx
edit_uri: edit/main/docs/

nav:
  - Home: index.md
  - Getting Started:
      - Installation: getting-started/installation.md
      - Quick Start: getting-started/quickstart.md
      - Authentication Flow: getting-started/authentication.md
      - Contributing: getting-started/contributing.md
  - Core Concepts:
      - Architecture: core-concepts/architecture.md
      - Event Model: core-concepts/event-model.md
      - Storage Backends: core-concepts/storage-backends.md
      - Type System: core-concepts/type-system.md
  - API Reference:
      - Client API Gateway: api/client.md
      - Storage Backends: api/backend.md
      - Client Namespaces:
          - Contact: api/contact.md
          - Chat Actions: api/chat-actions.md
          - Community: api/community.md
          - Newsletter: api/newsletter.md
          - Groups: api/groups.md
          - Status: api/status.md
          - Chatstate: api/chatstate.md
          - Blocking: api/blocking.md
          - Polls: api/polls.md
          - Presence: api/presence.md
          - Privacy: api/privacy.md
          - Profile: api/profile.md
      - Events API: api/events.md
      - Types API: api/types.md
      - Exceptions: api/exceptions.md
      - Helpers: api/helpers.md
      - WACore: api/wacore.md
  - Tutorials:
      - Command Bot: tutorials/command-bot.md
      - Profile & Privacy: tutorials/profile-privacy.md
      - Poll Survey: tutorials/poll-survey.md
      - Media Workflows: tutorials/media-workflows.md
      - Group Automation: tutorials/group-automation.md
  - Operations:
      - Deployment: operations/deployment.md
      - Reliability: operations/reliability.md
      - Troubleshooting: operations/troubleshooting.md
      - Performance: operations/performance.md
      - Security: operations/security.md
  - Reference:
      - FAQ: faq/qna.md
      - Glossary: reference/glossary.md
      - Error Handling: reference/error-handling.md
      - Roadmap: reference/roadmap.md
      - Changelog: reference/changelog.md

theme:
  name: material
  variant: modern
  language: en
  custom_dir: docs/overrides
  font:
    text: Inter
    code: JetBrains Mono
  features:
    - navigation.sections
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.top
    - navigation.path
    - navigation.tracking
    - navigation.instant
    - navigation.instant.progress
    - navigation.expand
    - navigation.indexes
    - navigation.footer
    - content.code.copy
    - content.code.annotate
    - content.code.line_highlight
    - content.tabs.link
    - content.tooltips
    - search.suggest
    - search.highlight
    - search.share
    - toc.follow
    - toc.integrate
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: teal
      accent: teal
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: teal
      accent: teal
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  icon:
    repo: fontawesome/brands/github

plugins:
  - search
  - mike:
      alias_type: symlink
      redirect_template: null
      deploy_prefix: ""
      canonical_version: null
      version_selector: true
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          paths: [python]
          inventories:
            - https://docs.python.org/3/objects.inv
          options:
            allow_inspection: false
            find_stubs_package: true
            show_source: true
            show_root_heading: true
            show_root_full_path: false
            show_category_heading: true
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            heading_level: 3
            members_order: source
            docstring_style: google
            docstring_section_style: spacy
            merge_init_into_class: true
            show_signature_annotations: true
            separate_signature: true
            signature_crossrefs: true
      enable_inventory: true

markdown_extensions:
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - tables
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:zensical.extensions.emoji.twemoji
      emoji_generator: !!python/name:zensical.extensions.emoji.to_svg
  - pymdownx.inlinehilite
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
      slugify: !!python/object/apply:pymdownx.slugs.slugify
        kwds:
          case: lower
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.snippets
  - toc:
      permalink: true
      toc_depth: 2-4

extra_css:
  - assets/stylesheets/extra.css

extra:
  version:
    provider: mike
    default: latest
    alias: true
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/krypton-byte/tryx
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/tryx/
  generator: false