mkdocs.yml

site_name: Universal Scheduling Protocol
site_url: https://usp-protocol.dev
site_description: The open standard for agentic scheduling. Discover, check availability, and book time-based services.
site_author: USP Authors

docs_dir: site-docs

repo_url: https://github.com/wix/universal-scheduling-protocol
repo_name: USP on GitHub

theme:
  name: material
  custom_dir: overrides
  language: en
  font:
    text: Google Sans
    code: Roboto Mono
  palette:
    - scheme: default
      primary: white
      accent: indigo
    - scheme: slate
      primary: black
      accent: indigo
    - scheme: slate
      primary: black
      accent: indigo
  logo: assets/usp-logo.svg
  favicon: assets/usp-logo.svg
  icon:
    repo: fontawesome/brands/github
  features:
    - navigation.sections
    - navigation.expand
    - navigation.top
    - navigation.indexes
    - navigation.footer
    - navigation.tracking
    - content.code.copy
    - content.code.annotate
    - content.code.select
    - content.tabs.link
    - content.tooltips
    - toc.follow
    - search.suggest
    - search.highlight
    - announce.dismiss

nav:
  - Overview:
    - Home: index.md
    - Core Concepts: core-concepts.md
    - Specification: specification/index.md
    - Getting Started: getting-started.md
    - Security: security.md
    - Extensions: extensions.md
    - Namespace Registry: namespace.md
    - Problem Types: errors/index.md
    - Roadmap: roadmap.md
  - Specification:
    - specification/index.md
    - Service Catalog: specification/service-catalog.md
    - Availability: specification/availability.md
    - Booking Lifecycle: specification/booking.md
    - Discovery Registry: specification/discovery-registry.md
    - Deployment Modes:
      - deployment-modes/index.md
      - UCP-Native Mode: deployment-modes/ucp-native.md
      - Standalone Mode: deployment-modes/standalone.md
    - Transport Bindings:
      - transport/index.md
      - REST: transport/rest.md
      - MCP: transport/mcp.md
      - A2A: transport/a2a.md
      - ESP: transport/esp.md
    - Playground: playground/index.md

plugins:
  - search:
      lang: en
      separator: '[\s\-\.]+'
  - meta
  - minify:
      minify_html: true

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.mark
  - pymdownx.critic
  - pymdownx.keys
  - attr_list
  - md_in_html
  - def_list
  - footnotes
  - tables
  - toc:
      permalink: true
      toc_depth: 3
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

extra_css:
  - stylesheets/extra.css

extra_javascript:
  - javascripts/extra.js

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/wix/universal-scheduling-protocol
      name: USP on GitHub
  generator: false
  analytics:
    provider: google
    property: G-XXXXXXXXXX
  consent:
    scope: /
    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.

copyright: >
  Copyright © 2026 USP Authors —
  Released under the <a href="https://www.apache.org/licenses/LICENSE-2.0">Apache License 2.0</a>