mkdocs.yml

# Project information
site_name: Agent Assembly Python SDK
site_url: https://ai-agent-assembly.github.io/python-sdk/
site_author: Agent Assembly Team
site_description: >-
  Python SDK for AI Agent Assembly — a governance-native runtime for AI agents.
  Wire framework adapters, enforce policy on tool calls, and emit audit events
  with one init_assembly() call.

# Repository
repo_name: ai-agent-assembly/python-sdk
repo_url: https://github.com/ai-agent-assembly/python-sdk
edit_uri: edit/master/docs/

# Copyright
copyright: Copyright © 2026 Agent Assembly Team

# Brand styling — shared doc brand kit (AAASM-2733)
extra_css:
  - stylesheets/aaasm-brand.css

theme:
  name: material
  custom_dir: ./docs/_overrides
  features:
    - announce.dismiss
    - content.action.edit
    - content.action.view
    - content.code.annotate
    - content.code.copy
    - content.tooltips
    - navigation.footer
    - navigation.indexes
    - navigation.sections
    - navigation.tabs
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow
  palette:
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Follow system
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  font:
    text: Inter
    code: JetBrains Mono
  logo: assets/logo.png
  favicon: assets/favicon.png

# Plugins
plugins:
  # Built-in client-side search — restores the search bar in the rendered site.
  - search
  # Doc-as-Code — render Python API reference inline from package docstrings.
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: google
            docstring_section_style: spacy
            docstring_options:
              ignore_init_summary: true
            merge_init_into_class: true
            relative_crossrefs: true
            show_source: true
            show_signature_annotations: true
            separate_signature: true
  # Versioning documentation — every master push deploys to "latest", releases promote to "stable".
  - mike:
      alias_type: symlink
      redirect_template: null
      deploy_prefix: ''
      canonical_version: null
      version_selector: true
      css_dir: css
      javascript_dir: js
  # Documentation modification info — per-page "last updated" timestamp.
  - git-revision-date-localized:
      type: timeago
      timezone: Asia/Taipei
      fallback_to_build_date: false
      enable_creation_date: true
      enable_git_follow: true
      enabled: true
      strict: true
  # Documentation modification info — per-page author from local git history.
  # Reads `git log` directly (no GitHub token, works on feature branches),
  # so the last-updater renders immediately without waiting for a merge to master.
  - git-authors:
      show_contribution: false
      show_line_count: false
      show_email_address: false
      sort_authors_by: contribution

# Extensions
markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - toc:
      permalink: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
      emoji_index: !!python/name:material.extensions.emoji.twemoji
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink:
      repo_url_shorthand: true
      user: ai-agent-assembly
      repo: python-sdk
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

# Additional configuration
extra:
  # Google Analytics 4 — Measurement ID is public (embedded in the rendered site).
  analytics:
    provider: google
    property: G-L8JTJDG8G7
    # Native "Was this page helpful?" widget — mkdocs-material sends a GA4
    # `feedback` event carrying the chosen rating's `data` value. No free-text
    # is sent to GA: the negative note links to a pre-filled GitHub issue so the
    # reader explains there instead.
    feedback:
      title: Was this page helpful?
      ratings:
        - icon: material/emoticon-happy-outline
          name: This page was helpful
          data: 1
          note: >-
            Thanks for your feedback!
        - icon: material/emoticon-sad-outline
          name: This page could be improved
          data: 0
          note: >-
            Thanks for your feedback! Help us improve this page by
            <a href="https://github.com/ai-agent-assembly/python-sdk/issues/new?labels=docs,feedback&title=Docs%20feedback&body=Page%3A%20(paste%20the%20page%20URL)%0A%0AWhat%20could%20be%20improved%3F" target="_blank" rel="noopener">opening an issue</a>.
  # Cookie consent (GDPR) — gate analytics cookies behind explicit opt-in.
  consent:
    title: Cookie consent
    description: >-
      We use analytics cookies to understand how you use the docs so we can improve them.
    actions:
      - accept
      - reject
      - manage
    cookies:
      analytics:
        name: Google Analytics
        checked: true
  # Versioning documentation
  version:
    provider: mike
    default: stable
    alias: true
  # Social info
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/ai-agent-assembly/python-sdk
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/agent-assembly/

# Page tree
nav:
  - Docs Hub: https://ai-agent-assembly.github.io/agent-assembly-docs/
  - Python SDK: https://ai-agent-assembly.github.io/python-sdk/
  - Node SDK: https://ai-agent-assembly.github.io/node-sdk/
  - Go SDK: https://ai-agent-assembly.github.io/go-sdk/
  - Introduction: index.md
  - Quick Start: quick-start.md
  - Core Concepts:
      - concepts/index.md
      - Architecture (deep dive): concepts/architecture.md
  - Guides:
      - guides/index.md
      - Handling allow/deny decisions: guides/handling-decisions.md
      - Authoring a framework adapter: guides/authoring-adapters.md
      - Type checking: guides/type-checking.md
  - Examples:
      - examples/index.md
      - Preparing the runtime environment: examples/preparing-the-runtime-environment.md
      - Framework support: examples/framework-support.md
      - LangChain — basic agent: examples/langchain-basic-agent.md
      - LangChain — research agent: examples/langchain-research-agent.md
      - LangGraph — node-level governance: examples/langgraph.md
      - CrewAI — multi-agent research crew: examples/crewai-research-crew.md
      - OpenAI Agents SDK: examples/openai-agents-sdk.md
      - Pydantic AI: examples/pydantic-ai.md
      - Google ADK: examples/google-adk.md
      - Haystack: examples/haystack.md
      - LlamaIndex: examples/llamaindex-tool-policy.md
      - Smolagents: examples/smolagents.md
      - Agno: examples/agno.md
      - Microsoft Agent Framework: examples/microsoft-agent-framework.md
      - Custom tool policy (no framework): examples/custom-tool-policy.md
  - Configuration: configuration.md
  - API Reference:
      - api-reference/index.md
      - Client: api-reference/client.md
      - Exceptions: api-reference/exceptions.md
      - Models: api-reference/models.md
  - Compatibility & Versioning:
      - compatibility/index.md
      - Framework compatibility: compatibility/frameworks.md
      - Runtime compatibility: compatibility/runtime.md
      - Release process: compatibility/release-process.md
      - Release notes: compatibility/release-notes.md
  - Troubleshooting: troubleshooting.md
  - Development:
      - development/index.md
      - ADR:
          - 0001 — Hook architecture: development/adr/0001-hook-architecture.md