mkdocs.yml

# yaml-language-server: $schema=https://squidfunk.github.io/mkdocs-material/schema.json
site_name: Ossum Technologies
site_url: https://ossum.tech/
site_description: >-
  Documentation for RIDDL - a specification language for large, distributed,
  reactive systems. Learn to model internet-scale applications with DDD patterns.
repo_url: https://github.com/ossuminc/ossum.tech
repo_name: ossuminc/ossum.tech
edit_uri: edit/main/docs/
copyright: >
  Copyright © 2019-2026 Ossum Inc. -
  <a href="#__consent">Change cookie settings</a>
theme:
  name: material
  custom_dir: overrides
  logo: assets/images/ossum_logo_and_name-01.png
  favicon: assets/images/favicon.jpg
  font:
    text: Encode Sans
    code: Roboto Mono
  features:
    - announce.dismiss
    - content.action.edit
    - content.tooltips
    - header.autohide
    - navigation.footer
    - navigation.instant
    - navigation.instant.progress
    - navigation.tracking
    - navigation.tabs
    - navigation.tabs.sticky
    - search.suggest
    - search.share
    - search.highlight
  icon:
    admonition:
      note: fontawesome/solid/note-sticky
      abstract: fontawesome/solid/book
      info: fontawesome/solid/circle-info
      tip: fontawesome/solid/bullhorn
      hint: fontawesome/solid/bullhorn
      success: fontawesome/solid/check
      question: fontawesome/solid/circle-question
      warning: fontawesome/solid/triangle-exclamation
      failure: fontawesome/solid/bomb
      danger: fontawesome/solid/skull
      bug: fontawesome/solid/robot
      example: fontawesome/solid/flask
      quote: fontawesome/solid/quote-left
  palette:
    # Palette toggle for automatic mode
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode

    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to system preference
extra_css:
  - stylesheets/extra.css

extra_javascript:
  - javascripts/extra.js

extra:
  analytics:
    provider: google
    property: G-97Q04B6XCX
  consent:
    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.
    cookies:
      analytics: GA_ossum_tech
      github: GH_ossum_tech
    consent:
      actions:
        - accept
        - reject
        - manage
  social:
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/company/ossum-inc/
    - icon: fontawesome/brands/github
      link: https://www.github.com/ossuminc
  generator: false

markdown_extensions:
    # Python Markdown
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - toc:
      permalink: true

    # Python Markdown Extensions
  - 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
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.snippets:
      base_path: docs
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

plugins:
  - search
  - offline

nav:
  - Home: index.md
  - RIDDL:
    - riddl/index.md
    - Quickstart: riddl/quickstart.md
    - Tutorials:
      - riddl/tutorials/index.md
      - Getting Started: riddl/tutorials/basics.md
      - Reactive BBQ Case Study:
        - riddl/tutorials/rbbq/index.md
        - Scenario: riddl/tutorials/rbbq/scenario.md
        - Domain Model: riddl/tutorials/rbbq/reactive-bbq.md
        - Restaurant:
          - riddl/tutorials/rbbq/restaurant/index.md
          - Front of House: riddl/tutorials/rbbq/restaurant/front-of-house.md
          - Kitchen: riddl/tutorials/rbbq/restaurant/kitchen.md
          - Bar: riddl/tutorials/rbbq/restaurant/bar.md
          - Online Ordering: riddl/tutorials/rbbq/restaurant/online-ordering.md
          - Delivery: riddl/tutorials/rbbq/restaurant/delivery.md
          - Loyalty: riddl/tutorials/rbbq/restaurant/loyalty.md
        - BackOffice:
          - riddl/tutorials/rbbq/backoffice/index.md
          - Scheduling: riddl/tutorials/rbbq/backoffice/scheduling.md
          - Inventory: riddl/tutorials/rbbq/backoffice/inventory.md
          - Reporting: riddl/tutorials/rbbq/backoffice/reporting.md
        - Corporate:
          - riddl/tutorials/rbbq/corporate/index.md
          - Menu Management: riddl/tutorials/rbbq/corporate/menu-management.md
          - Supply Chain: riddl/tutorials/rbbq/corporate/supply-chain.md
          - Marketing: riddl/tutorials/rbbq/corporate/marketing.md
        - External Systems: riddl/tutorials/rbbq/external-contexts.md
        - Patterns: riddl/tutorials/rbbq/patterns.md
        - Personas:
          - riddl/tutorials/rbbq/personas/index.md
          - CEO: riddl/tutorials/rbbq/personas/ceo.md
          - Head Chef: riddl/tutorials/rbbq/personas/head-chef.md
          - Host: riddl/tutorials/rbbq/personas/host.md
          - Server: riddl/tutorials/rbbq/personas/server.md
          - Bartender: riddl/tutorials/rbbq/personas/bartender.md
          - Chef: riddl/tutorials/rbbq/personas/chef.md
          - Cook: riddl/tutorials/rbbq/personas/cook.md
          - Delivery Driver: riddl/tutorials/rbbq/personas/delivery-driver.md
          - Online Customer: riddl/tutorials/rbbq/personas/online-customer.md
    - Introduction:
      - riddl/introduction/index.md
      - What is RIDDL?: riddl/introduction/what-is-riddl.md
      - Why is RIDDL Needed?: riddl/introduction/why-is-riddl-needed.md
      - What Can RIDDL Do?: riddl/introduction/what-can-riddl-do.md
      - What is RIDDL Based On?: riddl/introduction/what-is-riddl-based-on.md
      - What Conventions Does RIDDL Use?: riddl/introduction/what-conventions-does-riddl-use.md
      - Who Can Benefit from RIDDL?: riddl/introduction/who-can-benefit-from-riddl.md
      - Who Made RIDDL Possible?: riddl/introduction/who-made-riddl-possible.md
      - How Can I Get Help?: riddl/introduction/how-can-i-get-help.md
    - Concepts:
      - riddl/concepts/index.md
      - Root: riddl/concepts/root.md
      - Domain: riddl/concepts/domain.md
      - Context: riddl/concepts/context.md
      - Entity: riddl/concepts/entity.md
      - Repository: riddl/concepts/repository.md
      - Projector: riddl/concepts/projector.md
      - Saga: riddl/concepts/saga.md
      - Saga Step: riddl/concepts/sagastep.md
      - Streamlet: riddl/concepts/streamlet.md
      - Adaptor: riddl/concepts/adaptor.md
      - Application: riddl/concepts/application.md
      - Epic: riddl/concepts/epic.md
      - Use Case: riddl/concepts/use-case.md
      - User: riddl/concepts/user.md
      - Interaction: riddl/concepts/interaction.md
      - Handler: riddl/concepts/handler.md
      - On Clause: riddl/concepts/onclause.md
      - Function: riddl/concepts/function.md
      - Type: riddl/concepts/type.md
      - Field: riddl/concepts/field.md
      - State: riddl/concepts/state.md
      - Constant: riddl/concepts/constant.md
      - Invariant: riddl/concepts/invariant.md
      - Message: riddl/concepts/message.md
      - Inlet: riddl/concepts/inlet.md
      - Outlet: riddl/concepts/outlet.md
      - Connector: riddl/concepts/connector.md
      - Group: riddl/concepts/group.md
      - Input: riddl/concepts/input.md
      - Output: riddl/concepts/output.md
      - Case: riddl/concepts/case.md
      - Conditional: riddl/concepts/conditional.md
      - Statement: riddl/concepts/statement.md
      - Include: riddl/concepts/include.md
      - Author: riddl/concepts/author.md
      - Term: riddl/concepts/term.md
      - Comment: riddl/concepts/comment.md
      - Description: riddl/concepts/description.md
      - Metadata: riddl/concepts/metadata.md
      - Option: riddl/concepts/option.md
      - Element: riddl/concepts/element.md
      - Definition: riddl/concepts/definition.md
      - Value: riddl/concepts/value.md
      - Vital: riddl/concepts/vital.md
      - Processor: riddl/concepts/processor.md
    - Guides:
      - riddl/guides/index.md
      - For Authors:
        - riddl/guides/authors/index.md
        - Design Guide:
          - riddl/guides/authors/design/index.md
          - Bounded Contexts: riddl/guides/authors/design/contexts.md
          - Command-Event Patterns: riddl/guides/authors/design/command-event-patterns.md
          - UI Modeling: riddl/guides/authors/design/ui-modeling.md
      - For Domain Experts:
        - riddl/guides/domain-experts/index.md
        - Duties: riddl/guides/domain-experts/duties.md
        - Relating to RIDDL: riddl/guides/domain-experts/relating-to-riddl.md
      - For Implementors:
        - riddl/guides/implementors/index.md
        - Ways to Use RIDDL: riddl/guides/implementors/ways-to-use-riddl.md
      - For Developers:
        - riddl/guides/developers/index.md
        - Design Principles: riddl/guides/developers/principles.md
        - Releasing: riddl/guides/developers/releasing.md
    - Examples: riddl/examples/index.md
    - Playground: riddl/playground/index.md
    - References:
      - riddl/references/index.md
      - Cheat Sheet: riddl/references/cheat-sheet.md
      - Standard Highlighting: riddl/references/standard-highlighting.md
      - Language Reference: riddl/references/language-reference.md
      - EBNF Grammar: riddl/references/ebnf-grammar.md
    - Tools:
      - riddl/tools/index.md
      - riddlc:
        - riddl/tools/riddlc/index.md
        - Installation: riddl/tools/riddlc/installation.md
        - Command Reference: riddl/tools/riddlc/command-reference.md
        - Configuration: riddl/tools/riddlc/configuration.md
        - Compilation: riddl/tools/riddlc/compilation.md
        - GitHub Actions: riddl/tools/riddlc/github-actions.md
      - sbt-riddl: riddl/tools/sbt-riddl/index.md
      - MCP Server: riddl/tools/riddl-mcp-server/index.md
      - IntelliJ Plugin: riddl/tools/riddl-idea-plugin/index.md
  - Synapify:
    - synapify/index.md
    - User Interface: synapify/user-interface.md
    - Generation: synapify/generation.md
    - Simulation: synapify/simulation.md
  - MCP:
    - MCP/index.md
    - Claude Desktop: MCP/claude-desktop.md
    - Claude Code: MCP/claude-code.md
    - GitHub Copilot CLI: MCP/github-copilot.md
    - VS Code Copilot: MCP/vscode-copilot.md
    - Gemini: MCP/gemini.md
    - IntelliJ AI Assistant: MCP/intellij-ai.md
    - IntelliJ Junie: MCP/intellij-junie.md
  - IDE Support:
    - OSS/index.md
    - IntelliJ IDEA Plugin: OSS/intellij-plugin/index.md
    - VS Code Extension: OSS/vscode-extension/index.md
    - Authoring RIDDL: OSS/authoring-riddl.md
  - Coming Soon: coming-soon/index.md
  - About:
    - about/index.md
    - Privacy Policy: about/privacy-policy.md