mkdocs.yml

site_name: Nodos Docs
site_description: Documentation for Nodos, a node-graph based real-time computing and rendering engine.
theme:
  name: material
  # Brand mark from nodos.dev. The dark variant is swapped in by stylesheets/extra.css
  # when the slate scheme is active; favicon.svg is nodos.dev's own self-inverting icon.
  logo: assets/nodos-logo.png
  favicon: assets/favicon.svg
  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
      primary: white
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      toggle:
        icon: material/brightness-4
        name: Switch to system preference
  features:
    - content.code.copy
    - content.code.select
    - content.tabs.link
    - navigation.indexes
    - navigation.tabs
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.suggest
    - toc.follow
markdown_extensions:
  - admonition
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.details
  - pymdownx.tasklist:
      custom_checkbox: true
  - attr_list
  - def_list
  - md_in_html
  - tables
  - toc:
      permalink: true
extra_css:
- stylesheets/extra.css
plugins:
    - search
    - macros
    # Keeps links to the pre-Diataxis page layout working.
    - redirects:
        redirect_maps:
          introduction.md: index.md
          generics.md: developing/reference/builtin-types.md
          installation.md: using/how-to/install-nodos.md
          troubleshooting.md: about/get-help.md
          contributing.md: about/contributing.md
          pricing.md: about/licensing.md
          usages/index.md: using/tutorials/your-first-graph.md
          usages/ai_models.md: using/tutorials/running-an-ai-model.md
          usages/launcher.md: using/reference/launcher-cli.md
          development/index.md: developing/reference/builtin-types.md
          development/plugins/index.md: developing/tutorials/your-first-plugin.md
          development/process/index.md: developing/how-to/connect-an-external-app.md
          development/subsystems/index.md: developing/reference/subsystems/index.md
          development/subsystems/nos.sys.vulkan.md: developing/reference/subsystems/nos.sys.vulkan.md
extra:
    # Version knobs. Bump here rather than editing prose.
    nodos_version: "1.4"
    legacy_version: "1.3"
    plugin_sdk_version: "41.0"
    process_sdk_version: "21.0"
    cpp_version: "C++20"

# Structure: audience first, then the four Diataxis modes within each.
#   Using Nodos      - install, build and run graphs, manage modules
#   Developing       - plugins, subsystems, application integration
# Within an audience:
#   Tutorials   - learning-oriented, take a beginner through a working result
#   How-to      - task-oriented, solve one problem for someone who knows the goal
#   Reference   - information-oriented, describe the machinery, no instruction
#   Explanation - understanding-oriented, discuss why things are the way they are
# Keep new pages inside the mode they belong to; do not mix modes on one page.
# Pages that serve both audiences live under "Using Nodos" and are cross-linked,
# on the principle that developers are a superset of users.
nav:
  - Home: index.md
  - Using Nodos:
    - using/index.md
    - Tutorials:
      - Your first graph: using/tutorials/your-first-graph.md
      - Running an AI model: using/tutorials/running-an-ai-model.md
    - How-to guides:
      - Install Nodos: using/how-to/install-nodos.md
      - Manage packages: using/how-to/manage-packages.md
      - Run Nodos headless: using/how-to/run-nodos-headless.md
    - Reference:
      - nodos CLI: using/reference/nodos-cli.md
      - Launcher CLI: using/reference/launcher-cli.md
    - Explanation:
      - Architecture: using/explanation/architecture.md
      - Scheduling and execution: using/explanation/scheduling.md
  - Developing for Nodos:
    - developing/index.md
    - Tutorials:
      - Your first plugin: developing/tutorials/your-first-plugin.md
    - How-to guides:
      - Add nodes and pins: developing/how-to/add-nodes-and-pins.md
      - Depend on another module: developing/how-to/depend-on-another-module.md
      - Write a shader-only node: developing/how-to/write-a-shader-node.md
      - Use the Vulkan subsystem: developing/how-to/use-the-vulkan-subsystem.md
      - Connect an external application: developing/how-to/connect-an-external-app.md
      - Publish a package: developing/how-to/publish-a-package.md
      - Migrate a plugin to 1.4: developing/how-to/migrate-1-3-to-1-4.md
    - Reference:
      - Plugin manifest: developing/reference/plugin-manifest.md
      - Node definition: developing/reference/node-definition.md
      - Plugin API (C++): developing/reference/plugin-api.md
      - Node lifecycle and callbacks: developing/reference/node-lifecycle.md
      - Application SDK: developing/reference/app-sdk.md
      - Built-in data types: developing/reference/builtin-types.md
      - Workspace layout: developing/reference/workspace-layout.md
      - Subsystems:
        - developing/reference/subsystems/index.md
        - "nos.sys.vulkan": developing/reference/subsystems/nos.sys.vulkan.md
    - Explanation:
      - Extension model: developing/explanation/extension-model.md
      - Objects and the type system: developing/explanation/objects-and-types.md
      - Versioning and SDK lines: developing/explanation/versioning.md
  - About:
    - Get help: about/get-help.md
    - Licensing: about/licensing.md
    - Contributing: about/contributing.md
    - Changelog:
      - "What's New in 1.3": changelog/nodos-1.3-broadcast.md