mkdocs.yaml

site_name: 'ThothCTL'
site_description: 'ThothForge CLI - The Internal Developer Platform CLI'
site_author: 'ThothForge Team'
site_url: 'https://thothctl.readthedocs.io/'

# Repository
repo_url: https://github.com/thothforge/thothctl
repo_name: thothforge/thothctl
edit_uri: edit/main/docs/

# Copyright
copyright: 'Copyright © 2026 ThothForge'

# Configuration
docs_dir: 'docs'
site_dir: 'site'

# Navigation
nav:
  - Home: index.md
  - Quick Start: quick_start.md
  - Installation:
    - Windows: installation/windows_installation.md
  - Commands:
    - Init: framework/commands/init/init.md
    - List:
      - Overview: framework/commands/list/list_overview.md
      - Projects: framework/commands/list/list_projects.md
      - Spaces: framework/commands/list/list_spaces.md
    - Project:
      - Overview: framework/commands/project/project_overview.md
      - Convert: framework/commands/project/project_convert.md
      - Upgrade: framework/commands/project/project_upgrade.md
      - Cleanup: framework/commands/project/project_cleanup.md
      - Use Cases: framework/commands/project/use_cases.md
    - Remove:
      - Overview: framework/commands/remove/remove_overview.md
      - Projects: framework/commands/remove/remove_project.md
      - Spaces: framework/commands/remove/remove_space.md
    - Check: 
      - Overview: framework/commands/check/check_overview.md
      - IaC Check: framework/commands/check/check_iac.md
      - Customizing Rules: framework/commands/check/customizing_rules.md
      - Cost Analysis: framework/commands/check/cost-analysis.md
      - Blast Radius: framework/commands/check/blast-radius.md
      - Drift Detection: framework/commands/check/drift-detection.md
      - Dependencies: framework/commands/check/deps.md
      - Plan: framework/commands/check/plan.md
    - Scan:
      - Overview: framework/commands/scan/scan_overview.md
      - IaC Scanning: framework/commands/scan/scan_iac.md
      - Use Cases: framework/commands/scan/use_cases.md
    - Document:
      - Overview: framework/commands/document/document_overview.md
      - IaC Documentation: framework/commands/document/document_iac.md
      - Use Cases: framework/commands/document/use_cases.md
    - Inventory:
      - Overview: framework/commands/inventory/inventory_overview.md
      - IaC Inventory: framework/commands/inventory/inventory_iac.md
      - Frameworks:
        - Terraform: framework/commands/inventory/frameworks/terraform.md
        - Terragrunt: framework/commands/inventory/frameworks/terragrunt.md
    - Generate:
      - Components: framework/commands/generate/generate_components.md
      - Stacks: framework/commands/generate/generate_stacks.md
    - MCP: framework/commands/mcp/mcp.md
    - AI Review:
      - Overview: framework/commands/ai-review/README.md
  - Framework:
    - Framework Architecture: framework/framework_architecture.md
    - Software Architecture: framework/software_architecture.md
    - Concepts: framework/concepts.md
    - Infrastructure Composition: framework/infrasctructure_composition.md
    - Space Configuration: framework/space_configuration.md
    - Cross-Platform Support: framework/cross_platform_support.md
  - Use Cases:
    - Overview: framework/use_cases/README.md
    - AI Development Lifecycle (AI-DLC): framework/use_cases/ai_dlc.md
    - Platform Engineering Templates: framework/use_cases/platform_engineering_templates.md
    - DevSecOps SDLC Guide: framework/use_cases/devsecops_sdlc.md
    - DevSecOps Quick Start: framework/use_cases/devsecops_quickstart.md
    - Space Management: framework/use_cases/space_management.md
    - Check Command: framework/use_cases/check_command.md
    - Inventory Command: framework/use_cases/inventory_command.md
    - Template Engine: template_engine/template_engine.md
    - Tasks:
      - Create Template: framework/use_cases/tasks/create_template.md
  - Troubleshooting:
    - General: troubleshooting/troubleshooting.md
    - Linux: troubleshooting/linux_troubleshooting.md
    - macOS: troubleshooting/macos_troubleshooting.md
    - Windows: troubleshooting/windows_troubleshooting.md
  - Reference:
    - IaC DevSecOps Use Case: iac_devsecops_use_case.md
    - MCP Integration: mcp.md
    - Telemetry: telemetry.md
    - FdI Roadmap: framework/roadmap_fdi.md

# Theme Configuration
theme:
  name: material
  language: en
  
  # Logo and favicon
  logo: img/framework/thothforge-framework.svg
  favicon: img/framework/thothforge-framework.svg
  
  # Color palette
  palette:
    # Light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  
  # Font configuration
  font:
    text: Roboto
    code: Roboto Mono
  
  # Features
  features:
    # Navigation
    - navigation.instant        # Instant loading
    - navigation.instant.prefetch  # Prefetch pages
    - navigation.instant.progress  # Progress indicator
    - navigation.tracking       # Anchor tracking
    - navigation.tabs           # Top-level tabs
    - navigation.tabs.sticky    # Sticky tabs
    - navigation.sections       # Section navigation
    - navigation.expand         # Expand navigation by default
    - navigation.path           # Breadcrumbs
    - navigation.indexes        # Section index pages
    - navigation.top            # Back to top button
    - navigation.footer         # Footer navigation
    
    # Search
    - search.suggest            # Search suggestions
    - search.highlight          # Highlight search terms
    - search.share              # Share search results
    
    # Table of contents
    - toc.follow                # Follow TOC
    - toc.integrate             # Integrate TOC
    
    # Content
    - content.code.copy         # Copy code button
    - content.code.annotate     # Code annotations
    - content.tabs.link         # Link content tabs
    - content.tooltips          # Tooltips
    
    # Header
    - header.autohide           # Auto-hide header

# Plugins
plugins:
  - search:
      separator: '[\s\-,:!=\[\]()"/]+|(?!\b)(?=[A-Z][a-z])|\.(?!\d)|&[lg]t;'
      lang:
        - en
  - minify:
      minify_html: true
      minify_js: true
      minify_css: true
      htmlmin_opts:
        remove_comments: true
      cache_safe: true

# Extensions
markdown_extensions:
  # Python Markdown
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - tables
  - toc:
      permalink: true
      permalink_title: Anchor link to this section
      toc_depth: 3
  
  # Python Markdown Extensions
  - 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.mark
  - pymdownx.smartsymbols
  - pymdownx.snippets:
      check_paths: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
      combine_header_slug: true
      slugify: !!python/object/apply:pymdownx.slugs.slugify
        kwds:
          case: lower
  - pymdownx.tasklist:
      custom_checkbox: true
      clickable_checkbox: true
  - pymdownx.tilde

# Extra CSS and JavaScript
extra_css:
  - stylesheets/extra.css

extra_javascript:
  - https://unpkg.com/tablesort@5.3.0/dist/tablesort.min.js
  - javascripts/tablesort.js

# Extra configuration
extra:
  version:
    provider: mike
    default: latest
  
  # Social links
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/thothforge/thothctl
      name: ThothCTL on GitHub
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/thothctl/
      name: ThothCTL on PyPI
    - icon: fontawesome/brands/docker
      link: https://hub.docker.com/r/thothforge/thothctl
      name: ThothCTL on Docker Hub
  
  # Analytics (optional - uncomment and configure)
  # analytics:
  #   provider: google
  #   property: G-XXXXXXXXXX
  
  # Consent (optional - for GDPR compliance)
  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.
    actions:
      - accept
      - reject
      - manage

# Validation
validation:
  nav:
    omitted_files: info
    not_found: warn
    absolute_links: info
  links:
    not_found: warn
    absolute_links: info
    unrecognized_links: info