mkdocs.yml

# MkDocs Configuration for taskprovision Project
site_name: taskprovision - Multi-Level Solution Architecture Generator
site_description: "AI-powered solution architecture generator using Ollama Mistral:7b with Inception-inspired multi-level approach"
site_author: "taskprovision Development Team"
site_url: "https://taskprovision.github.io/taskprovision"
  
# Serve from root
docs_dir: docs
site_dir: public

# Repository
repo_name: "taskprovision/python"
repo_url: "https://github.com/taskprovision/python"
edit_uri: "edit/main/docs/"

# Copyright
copyright: "Copyright © 2025 taskprovision Project Contributors"

# Configuration
theme:
  name: "material"
  palette:
    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: blue
      accent: cyan
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Palette toggle for dark mode  
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: blue
      accent: cyan
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  
  font:
    text: "Roboto"
    code: "Roboto Mono"
  
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.expand
    - navigation.path
    - navigation.indexes
    - navigation.top
    - search.highlight
    - search.share
    - search.suggest
    - content.code.copy
    - content.code.annotate
    - content.tabs.link
    - content.tooltips
    - header.autohide
    - announce.dismiss
    - toc.follow
    - toc.integrate

  icon:
    repo: fontawesome/brands/github
    edit: material/pencil
    view: material/eye
    admonition:
      note: octicons/tag-16
      abstract: octicons/checklist-16
      info: octicons/info-16
      tip: octicons/squirrel-16
      success: octicons/check-16
      question: octicons/question-16
      warning: octicons/alert-16
      failure: octicons/x-circle-16
      danger: octicons/zap-16
      bug: octicons/bug-16
      example: octicons/beaker-16
      quote: octicons/quote-16

  custom_dir: docs/overrides

# Extensions
markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - toc:
      permalink: true
      title: "On this page"
  - tables
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - 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.keys
  - pymdownx.magiclink:
      repo_url_shorthand: true
      user: taskprovision
      repo: taskprovision
  - 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

# Plugins
plugins:
  - search:
      lang: en
      separator: '[\s\-,:!=\[\]()"/]+|(?!\b)(?=[A-Z][a-z])|\.(?!\d)|&[lg]t;'
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          options:
            show_source: true
            show_root_heading: true
            show_root_full_path: false
            show_root_members_full_path: false
            show_category_heading: true
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            members_order: source
            docstring_style: google
            merge_init_into_class: true
            show_signature_annotations: true
            separate_signature: true
  - minify:
      minify_html: true
      minify_js: true
      minify_css: true
      htmlmin_opts:
          remove_comments: true
          remove_optional_attribute_quotes: false
          remove_optional_tags: false
      js_files:
          - '**/*.js'
      css_files:
          - '**/*.css'

# Customization
extra:
  version:
    provider: mike
    default: latest
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/taskprovision/python
      name: GitHub Repository
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/python/
      name: PyPI Package
    - icon: fontawesome/brands/docker
      link: https://hub.docker.com/r/taskprovision/python
      name: Docker Hub
  generator: false
  analytics:
    provider: google
    property: G-XXXXXXXXXX  # Replace with your Google Analytics ID
  consent:
    title: Cookie consent
    description: >- 
      We use cookies to recognize your repeated visits and preferences, as well
      as to measure the effectiveness of our documentation and whether users
      find what they're searching for. With your consent, you're helping us to
      make our documentation better.

# Page tree
nav:
  - Home: index.md
  - Getting Started:
    - Installation: installation.md
    - Quick Start: quick-start.md
  - Features: features.md
  - API Reference: api.md
  - Source Code: src.md

# Strict mode for better error reporting
strict: true

# Validation settings
validation:
  nav:  # Navigation validation
    omitted_files: warn  # Warn about files not included in navigation
    not_found: warn      # Warn about non-existent files in navigation
  links:  # Link validation
    not_found: warn      # Warn about broken links
    absolute_links: warn # Warn about absolute links (use relative links instead)
    unrecognized_links: warn  # Warn about links that don't match any known pattern

# Plugins configuration
plugins:
  - search:
      lang: en
      separator: '[\s\-,:!=\[\]()"/]+|(?!\b)(?=[A-Z][a-z])|\.(?!\d)|&[lg]t;'
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          options:
            show_source: true
            show_root_heading: true
            show_root_full_path: false
            show_root_members_full_path: false
            show_category_heading: true
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            members_order: source
            docstring_style: google
            merge_init_into_class: true
            show_signature_annotations: true
            separate_signature: true
  - minify:
      minify_html: true

# Development server
dev_addr: "127.0.0.1:8000"

# Build directory
site_dir: "site"