mkdocs.yml

site_name: Datest - Pytest-Inspired Testing Framework for Dana
site_description: Comprehensive documentation for Datest - Pytest-inspired testing framework for Dana, the agent-first neurosymbolic language
site_url: https://datest.readthedocs.io/
repo_url: https://github.com/aitomatic/datest
repo_name: aitomatic/datest

# Documentation and theme
theme:
  name: material
  logo: images/aitomatic-logo-white.png
  favicon: images/aitomatic-favicon.png
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.path
    - navigation.top
    - search.highlight
    - search.share
    - content.code.copy
    - content.code.annotate
  palette:
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  font:
    text: Roboto
    code: Roboto Mono

# Navigation structure
nav:
  - Home: 
    - Overview: README.md
    - For You:
      - Engineers: for-engineers/README.md
      - Evaluators: for-evaluators/README.md
      - Researchers: for-researchers/README.md
      - Contributors: for-contributors/README.md
      - Investors: for-investors/README.md
    - More:
      - Design: reference/README.md
      - Roadmap: ROADMAP.md
  - For Engineers:
    - Overview: for-engineers/README.md
    - Setup: 
      - Overview: for-engineers/setup/README.md
      - Installation: for-engineers/setup/installation.md
      - Migration Guide: for-engineers/setup/migration-guide.md
    - Reference:
      - Overview: for-engineers/reference/README.md
      - Dana Syntax: for-engineers/reference/dana-syntax.md
      - REPL Guide: for-engineers/reference/repl-guide.md
      - POET Usage Guide: for-engineers/reference/poet-usage-guide.md
      - API Reference:
        - Overview: for-engineers/reference/api/README.md
        - Core Functions: for-engineers/reference/api/core-functions.md
        - Built-in Functions: for-engineers/reference/api/built-in-functions.md
        - Function Calling: for-engineers/reference/api/function-calling.md
        - Type System: for-engineers/reference/api/type-system.md
        - Scoping: for-engineers/reference/api/scoping.md
        - Sandbox Security: for-engineers/reference/api/sandbox-security.md
        - Dana Sandbox: for-engineers/reference/api/dana-sandbox.md
    - Recipes:
      - Overview: for-engineers/recipes/README.md
      - First Agent: for-engineers/recipes/first-agent.md
      - Chatbot: for-engineers/recipes/chatbot/README.md
      - Document Processor: for-engineers/recipes/document-processor/README.md
      - API Integration: for-engineers/recipes/api-integration/README.md
      - MCP Integration: for-engineers/recipes/mcp-integration.md
      - MCP Integration: for-engineers/recipes/mcp-integration.md
      - Workflow Agent: for-engineers/recipes/workflow-agent/README.md
    - Troubleshooting: for-engineers/troubleshooting/README.md
  - For Evaluators:
    - Overview: for-evaluators/README.md
    - Comparison:
      - Overview: for-evaluators/comparison/README.md
      - Framework Pain Points: for-evaluators/comparison/framework-pain-points.md
      - Technical Overview: for-evaluators/comparison/technical-overview.md
    - Adoption Guide:
      - Overview: for-evaluators/adoption-guide/README.md
      - Professional Services: for-evaluators/adoption-guide/professional-services.md
    - Proof of Concept:
      - Overview: for-evaluators/proof-of-concept/README.md
      - Quick Demo: for-evaluators/proof-of-concept/quick-demo.md
      - Evaluation Guide: for-evaluators/proof-of-concept/evaluation-guide.md
    - ROI Analysis:
      - Overview: for-evaluators/roi-analysis/README.md
      - Calculator: for-evaluators/roi-analysis/calculator.md
  - For Researchers:
    - Overview: for-researchers/README.md
    - Manifesto:
      - Vision: for-researchers/manifesto/vision.md
    - Research: for-researchers/research/README.md
    - NeuroSymbolic: for-researchers/neurosymbolic/README.md
    - Future Work: for-researchers/future-work/README.md
  - For Contributors:
    - Overview: for-contributors/README.md
    - Architecture:
      - Overview: for-contributors/architecture/README.md
      - System Design: for-contributors/architecture/system-design.md
    - Codebase: for-contributors/codebase/README.md
    - Development:
      - Overview: for-contributors/development/README.md
      - Contribution Guide: for-contributors/development/contribution-guide.md
    - Extending:
      - Overview: for-contributors/extending/README.md
      - Extension Development: for-contributors/extending/extension-development.md
  - For Investors:
    - Overview: for-investors/README.md
  - Design:
    - Overview: reference/README.md
    - Dana Philosophy:
      - Design Principles: reference/00_dana_philosophy/design-principles.md
      - Manifesto: reference/00_dana_philosophy/manifesto.md
    - Dana Language Specification:
      - Overview: reference/01_dana_language_specification/overview.md
      - Syntax: reference/01_dana_language_specification/syntax.md
      - Grammar: reference/01_dana_language_specification/grammar.md
      - Data Types and Structs: reference/01_dana_language_specification/data_types_and_structs.md
      - Functions and Polymorphism: reference/01_dana_language_specification/functions_and_polymorphism.md
      - State and Scopes: reference/01_dana_language_specification/state_and_scopes.md
      - Error Handling: reference/01_dana_language_specification/error_handling.md
    - Dana Runtime and Execution:
      - Execution Model: reference/02_dana_runtime_and_execution/execution_model.md
      - Interpreter: reference/02_dana_runtime_and_execution/interpreter.md
      - Sandbox: reference/02_dana_runtime_and_execution/sandbox.md
      - REPL: reference/02_dana_runtime_and_execution/repl.md
      - Code Context Analyzer: reference/02_dana_runtime_and_execution/code_context_analyzer.md
      - POET Functions: reference/02_dana_runtime_and_execution/poet_functions.md
      - Type System and Casting: reference/02_dana_runtime_and_execution/type_system_and_casting.md
      - Concurrency Model: reference/02_dana_runtime_and_execution/concurrency_model.md
      - External Interfaces: reference/02_dana_runtime_and_execution/external_interfaces.md
      - Python Integration: reference/02_dana_runtime_and_execution/python_integration.md
      - Security Considerations: reference/02_dana_runtime_and_execution/security_considerations.md
      - Debugging and Profiling: reference/02_dana_runtime_and_execution/debugging_profiling.md
    - Core Capabilities and Resources:
      - Overview: reference/03_core_capabilities_resources/README.md
      - Capabilities Overview: reference/03_core_capabilities_resources/capabilities_overview.md
      - Resource Model: reference/03_core_capabilities_resources/resource_model.md
      - System Resources: reference/03_core_capabilities_resources/system_resources.md
      - User-defined Resources: reference/03_core_capabilities_resources/user_defined_resources.md
      - Capability Invocation: reference/03_core_capabilities_resources/capability_invocation.md
    - Agent and Orchestration:
      - Overview: reference/04_agent_and_orchestration/README.md
      - Agent Model: reference/04_agent_and_orchestration/agent_model.md
      - Task Orchestration: reference/04_agent_and_orchestration/task_orchestration.md
      - Workflow Patterns: reference/04_agent_and_orchestration/workflow_patterns.md
      - Inter-Agent Communication: reference/04_agent_and_orchestration/inter_agent_communication.md
      - Human-in-the-Loop: reference/04_agent_and_orchestration/human_in_the_loop.md
    - Tooling and Developer Experience:
      - Overview: reference/05_tooling_and_dev_experience/README.md
      - IDE Integration (VSCode): reference/05_tooling_and_dev_experience/ide_integration_vscode.md
      - REPL Enhancements: reference/05_tooling_and_dev_experience/repl_enhancements.md
      - Debugging Tools: reference/05_tooling_and_dev_experience/debugging_tools.md
      - Testing Framework: reference/05_tooling_and_dev_experience/testing_framework.md
      - Documentation Generation: reference/05_tooling_and_dev_experience/documentation_generation.md
      - Packaging and Distribution: reference/05_tooling_and_dev_experience/packaging_distribution.md

# Plugins
plugins:
  - search
  - mermaid2
  - section-index
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: google
            members_order: source
            show_source: true
            show_bases: true
  - git-revision-date-localized:
      type: datetime
      enable_creation_date: true
      enable_git_follow: false

# Markdown extensions
markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - tables
  - toc:
      permalink: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink:
      repo_url_shorthand: true
      user: aitomatic
      repo: datest
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.snippets
  - 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

# Extra settings
extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/aitomatic/datest
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/datest/

# Documentation directory
docs_dir: docs

# Exclude internal documentation from build
exclude_docs: internal/

# Build directory
site_dir: site

# Additional settings
strict: false
use_directory_urls: true

# Copyright
copyright: Copyright © 2025 Aitomatic, Inc.

# Custom CSS/JS
extra_css:
  - stylesheets/extra.css

extra_javascript:
  - javascripts/mathjax.js
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js