mkdocs.yml

site_name: Specification (pre-draft)
docs_dir: system-design

nav:
  - What is Margo?: index.md
  - Personas & Definitions:
      - personas-and-definitions/personas.md
      - personas-and-definitions/persona-examples.md
      - personas-and-definitions/technical-lexicon.md
      - personas-and-definitions/software-composition.md
  - Overview:
      - overview/envisioned-system-design.md
      - overview/applications.md
      - overview/workload-fleet-management.md
      - overview/edge-compute-devices.md
      - overview/workload-observability.md
  - Concepts:
      - Applications:
          - concepts/applications/application-package.md
          - concepts/applications/application-registry.md
          - concepts/applications/local-registries.md
      - Workload Fleet Managers:
          - concepts/workload-fleet-managers/device-client-onboarding.md
          - concepts/workload-fleet-managers/device-capabilities.md
          - concepts/workload-fleet-managers/workload-deployment.md
      - Edge Compute Devices:
          - concepts/edge-compute-devices/devices.md
  - Specification:
      - Margo Management Interface:
          - specification/margo-management-interface/api-requirements-and-security.md
          - specification/margo-management-interface/certificate-api.md
          - specification/margo-management-interface/device-client-onboarding.md
          - specification/margo-management-interface/device-capabilities.md
          - specification/margo-management-interface/desired-state.md
          - specification/margo-management-interface/deployment-status.md
          - specification/margo-management-interface/management-interface-swagger.md
      - Applications:
          - specification/applications/application-description.md
          - specification/applications/application-registry.md
      - Margo Devices:
          - specification/margo-devices/device-requirements.md
      - Observability: 
        - specification/observability/publishing-workload-observability-data.md
        - specification/observability/collecting-workload-observability-data.md
        - specification/observability/consuming-workload-observability-data.md

  - Make a Contribution:
      - make-a-contribution/contributing.md

theme:
  name: material
  features:
    #- navigation.tabs
    #- navigation.settings
    #- navigation.top
    #- navigation.sections
    - navigation.tracking
    - navigation.footer
    - toc.integrate
    - search.suggest
    - search.highlight
    - content.tabs.link
    - content.code.annotations
    - content.code.copy
  language: en
  font:
    text: IBM Plex Sans
    code: IBM Plex Mono
  logo: assets/margo_white.svg
  favicon: assets/favicon.ico
  palette:
    scheme: margo

markdown_extensions:
  - toc:
      toc_depth: 2
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format      

extra_css:
  - css/margo.css
  - assets/swagger-ui.css

extra_javascript:
  - assets/swagger-ui-bundle.js
  - assets/swagger-ui-standalone-preset.js


extra:
  # https://squidfunk.github.io/mkdocs-material/setup/setting-up-the-footer/#generator-notice
  generator: true
  homepage: https://margo.org
  copyright: Copyright © 2024 Margo
  reponame: !ENV [GITHUB_REPOSITORY, "margo/specification"]
  commit: !ENV [GITHUB_SHA, "<unknown>"]
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/margo
    - icon: fontawesome/brands/x-twitter
      link: https://twitter.com/margo_project
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/company/margoproject/about/
    - icon: fontawesome/brands/youtube
      link: https://www.youtube.com/@Margoinitiative
    - icon: fontawesome/brands/discord
      link: http://chat.margo.org/

plugins:
  - search
  - markdownextradata:
      jinja_options:
        variable_start_string: =@=
        variable_end_string: =@=
  - privacy