mkdocs.yml

site_name: ML Container Creator
site_description: The BYOC toolkit for Amazon SageMaker AI — generate, deploy, tune, and operate ML containers
site_url: https://awslabs.github.io/ml-container-creator/
repo_url: https://github.com/awslabs/ml-container-creator
repo_name: awslabs/ml-container-creator
edit_uri: edit/main/docs/

theme:
  name: material
  palette:
    - scheme: default
      primary: teal
      accent: pink
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: deep purple
      accent: pink
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.suggest
    - content.code.copy
    - content.code.annotate
  icon:
    repo: fontawesome/brands/github
  logo: logo.png
  favicon: logo.png

extra_css:
  - stylesheets/extra.css
  - stylesheets/manifold.css

extra_javascript:
  - js/command-generator.js
  - js/coverage-manifold.js

plugins:
  - search
  - tags

exclude_docs: |
  README.md

nav:
  - Home: index.md
  - Getting Started: getting-started.md
  - Supported Models: supported-models.md
  - SageMaker BYOC Contract: aws-sagemaker.md
  - Bootstrap: bootstrap.md
  - MCP Servers: mcp-configuration.md
  - User Guide:
      - Configuration: configuration.md
      - Secrets Management: secrets.md
      - Deployment & Inference: deployments.md
      - Fine-Tuning: fine-tuning.md
      - Custom Training: custom-training.md
      - Agent UX: agent.md
      - Examples: EXAMPLES.md
      - Troubleshooting: TROUBLESHOOTING.md
  - Operations:
      - CI Integration: ci-integration.md
      - Benchmarking: benchmarking.md
      - Model Registration (MPG): deployment-registry.md
      - Optimization: optimize.md
      - Speculative Decoding (HyperPod): hyperpod-speculative-decoding.md
      - Multi-Model Endpoints: mme-deployment-guide.md
      - Import/Update/Regenerate: import.md
      - Prove: prove.md
      - Path Prover: path-prover.md
      - Coverage Manifold: coverage-manifold.md
      - Status Badges: badge-examples.md
  - Developer Guide:
      - Contributing: CONTRIBUTING.md
      - Local Development: dev/local-development.md
      - Coding Standards: coding-standards.md
      - Adding Features: ADDING_FEATURES.md
      - Architecture: how-it-works.md
      - Schema-Driven Architecture: dev/schema-driven-architecture.md
      - Template System: dev/template-system.md
      - do/ Script Contracts: do-script-contract.md
      - MCP Server Development: dev/mcp-server-development.md
      - Registries and Catalogs: dev/registries-and-catalogs.md
      - Registry Contribution Guide: REGISTRY_CONTRIBUTION_GUIDE.md
      - Catalog Relationships: dev/catalog-relationship.md
      - Validation System: dev/validation-system.md
      - Accelerator Validators: ACCELERATOR_VALIDATOR_GUIDE.md
      - Testing: dev/testing.md
      - Architecture Corpus:
          - Overview: architecture/index.md
          - System Overview: architecture/system-overview.md
          - MCP Picker Servers: architecture/mcp-servers.md
          - Serve-Engine Plugins: architecture/serve-engine-plugins.md
          - Serve-Engine Plugin Authoring: architecture/serve-engine-plugin-authoring.md
          - Predictor-Framework Plugins: architecture/predictor-framework-plugins.md
          - Command Handlers & do/config: architecture/command-handlers.md
          - Validation Framework: architecture/validation.md
          - do/ Scripts: architecture/do-scripts.md
          - Adding a Deployment Target: architecture/deployment-target-authoring.md
          - Module-Header Convention: architecture/module-header-convention.md
      - Decision Records (ADRs):
          - ADR-001 Import Metadata Contract: adr/ADR-001-import-contract-metadata-schema.md
          - ADR-002 Consolidation Program: adr/ADR-002-consolidation-program.md
          - ADR-003 MCP Picker-Server Factory: adr/ADR-003-mcp-picker-server-factory.md
          - ADR-004 Serve-Engine Plugin Parity: adr/ADR-004-serve-engine-plugin-parity.md
          - ADR-005 Command-Handler Contract: adr/ADR-005-command-handler-contract.md
          - ADR-006 Unified Validation Framework: adr/ADR-006-unified-validation-framework.md
          - ADR-007 do/ Script Contract Enforcement: adr/ADR-007-do-script-contract-enforcement.md
          - ADR-008 Deployment-Target Descriptor: adr/ADR-008-deployment-target-descriptor.md
          - ADR-009 Serve-Engine Capability Versioning: adr/ADR-009-serve-engine-capability-versioning.md
      - Archive (point-in-time snapshots):
          - do/ Scripts — Wave 6 Changelog: architecture/do-scripts-wave6-changelog.md
          - Test Inventory: dev/test-inventory.md
  - Command Generator: command-generator.md
  - Release Notes: https://github.com/awslabs/ml-container-creator/releases

markdown_extensions:
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - tables
  - codehilite:
      guess_lang: false
  - pymdownx.snippets:
      base_path: docs/snippets
  - 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
  - pymdownx.inlinehilite
  - pymdownx.keys
  - 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
  - toc:
      permalink: true