mkdocs.yml

site_name: KMP-IMPACT
site_description: Reviewing Dependency Updates in Kotlin Multiplatform — a thesis-grade impact analyzer.
site_author: Esteban Castel
site_url: https://estebancastel.github.io/KMP-IMPACT-Reviewing-Dependency-Updates-in-Kotlin-Multiplatform/
repo_name: EstebanCastel/KMP-IMPACT-Reviewing-Dependency-Updates-in-Kotlin-Multiplatform
repo_url: https://github.com/EstebanCastel/KMP-IMPACT-Reviewing-Dependency-Updates-in-Kotlin-Multiplatform
edit_uri: edit/main/docs/
copyright: Copyright © 2026 Esteban Castel — MIT License

theme:
  name: material
  language: en
  features:
    - navigation.instant
    - navigation.instant.progress
    - navigation.tracking
    - navigation.sections
    - navigation.indexes
    - navigation.path
    - navigation.prune
    - navigation.top
    - navigation.footer
    - toc.follow
    - search.suggest
    - search.highlight
    - search.share
    - content.code.copy
    - content.code.annotate
    - content.code.select
    - content.tabs.link
    - content.action.edit
    - content.action.view
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/weather-night
        name: Switch to light mode
  font:
    text: Inter
    code: JetBrains Mono
  icon:
    repo: fontawesome/brands/github
    edit: material/pencil-outline
    view: material/eye-outline

nav:
  - Introduction: index.md
  - Getting Started:
      - getting-started/index.md
      - Installation: getting-started/installation.md
      - Requirements: getting-started/requirements.md
      - What gets installed: getting-started/what-gets-installed.md
      - Project Structure: getting-started/project-structure.md
      - Quickstart: getting-started/quickstart.md
  - Guides:
      - guides/index.md
      - Preparing an existing KMP project: guides/preparing-a-kmp-project.md
      - Configuring GitHub Actions: guides/github-actions.md
      - Configuring Dependabot: guides/dependabot.md
      - How everything talks to each other: guides/how-it-works.md
      - Analyzing a bump locally: guides/analyzing-locally.md
      - Writing Scenarios: guides/scenarios.md
      - Reading the Report: guides/reading-the-report.md
      - Diagnosing a BLOCKED phase: guides/diagnosing-blocked.md
  - Architecture:
      - architecture/index.md
      - Pipeline overview: architecture/pipeline-overview.md
      - Phase 1 — Shadow build: architecture/phase-1-shadow-build.md
      - Phase 2 — Static analysis: architecture/phase-2-static-analysis.md
      - Phase 3 — Dynamic analysis: architecture/phase-3-dynamic-analysis.md
      - Phase 4 — Consolidation: architecture/phase-4-consolidation.md
      - Phase 5 — Visualization: architecture/phase-5-visualization.md
  - API Reference:
      - reference/index.md
      - CLI:
          - reference/cli/index.md
          - "kmp-impact analyze": reference/cli/analyze.md
          - "kmp-impact run-scenario": reference/cli/run-scenario.md
          - "kmp-impact detect-version-changes": reference/cli/detect-version-changes.md
          - "kmp-impact evaluate": reference/cli/evaluate.md
      - Data Contracts:
          - reference/contracts/index.md
          - AnalysisConfig: reference/contracts/analysis-config.md
          - FileImpact: reference/contracts/file-impact.md
          - ExpectActualPair: reference/contracts/expect-actual-pair.md
          - ImpactGraph: reference/contracts/impact-graph.md
          - UIRegressions: reference/contracts/ui-regressions.md
          - ConsolidatedResult: reference/contracts/consolidated-result.md
      - GitHub Action: reference/github-action.md
  - Presets:
      - presets/index.md
      - Pokedex: presets/pokedex.md
      - Confetti: presets/confetti.md
      - DroidconKotlin: presets/droidcon-kotlin.md
      - KMP-App-Template: presets/kmp-app-template.md
      - kmp-production-sample: presets/kmp-production-sample.md
  - Troubleshooting: troubleshooting.md
  - Changelog: changelog.md

markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - tables
  - toc:
      permalink: true
      toc_depth: 3
  - pymdownx.betterem
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.snippets:
      base_path: ["."]
      check_paths: true
  - 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:
  - search

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/EstebanCastel
  generator: false

extra_css:
  - stylesheets/extra.css