mkdocs.yml

site_name: IronCore
repo_url: https://github.com/ironcore-dev/ironcore/
edit_uri: edit/main/docs/
theme:
  icon:
    repo: fontawesome/brands/github
  features:
  - navigation.instant
  - navigation.tracking
  - navigation.indexes
  - navigation.top
  name: material
  logo: assets/logo.svg
  favicon: assets/logo.png
  palette:
  - media: "(prefers-color-scheme: light)"
    scheme: default
    primary: white
    toggle:
      icon: material/weather-night
      name: Switch to dark mode
  - media: "(prefers-color-scheme: dark)"
    scheme: slate
    primary: black
    toggle:
      icon: material/weather-sunny
      name: Switch to light mode
  font:
    text: 'Work Sans'

plugins:
- search

markdown_extensions:
- pymdownx.highlight
- pymdownx.superfences:
    custom_fences:
    - name: mermaid
      class: mermaid
      format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.snippets
- codehilite
- admonition
- toc:
    permalink: true

nav:
- Home: README.md

- Architecture:
  - Overview: architecture/overview.md
  - Runtime Interface: architecture/iri.md

- Concepts:
  - Machine Exec: concepts/machine-exec-flow.md

- Usage:
  - Installation: usage/installation.md
  - Compute:
    - MachinePool: usage/compute/machinepool.md
    - MachineClass: usage/compute/machineclass.md
    - Machine: usage/compute/machine.md
  - Storage:
    - VolumePool: usage/storage/volumepool.md
    - VolumeClass: usage/storage/volumeclass.md
    - Volume: usage/storage/volume.md
    - BucketPool: usage/storage/bucketpool.md
    - BucketClass: usage/storage/bucketclass.md
    - Bucket: usage/storage/bucket.md
  - Networking:
      - Network: usage/networking/network.md
      - NetworkInterface: usage/networking/networkinterface.md
      - NATGateway: usage/networking/natgateway.md
      - LoadBalancer: usage/networking/loadbalancer.md
      - VirtualIP: usage/networking/virtualip.md
      - NetworkPolicy: usage/networking/networkpolicy.md
  - IPAM:
      - Prefix: usage/ipam/prefix.md
  - Core:
      - ResourceQuota: usage/core/resourcequota.md

- Developer Guide:
  - Local Setup: development/setup.md
  - Documentation: development/documentation.md
  - Testing: development/testing.md
  - Contribution Guide: development/contribution.md

- Proposals: proposals/README.md

- API Reference:
  - Overview: api-reference/overview.md
  - IPAM: api-reference/ipam.md
  - Core: api-reference/core.md
  - Compute: api-reference/compute.md
  - Networking: api-reference/networking.md
  - Storage: api-reference/storage.md
  - Common: api-reference/common.md

extra:
  social:
  - icon: fontawesome/brands/github
    link: https://github.com/ironcore-dev/ironcore