mkdocs.yml

site_name: Renderflow
site_url: https://egohygiene.github.io/renderflow/
repo_name: egohygiene/renderflow
repo_url: https://github.com/egohygiene/renderflow
edit_uri: edit/main/docs/

theme:
  name: material
  features:
    - navigation.tabs
    - navigation.top
    - content.code.copy
    - search.suggest
    - search.highlight
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode

plugins:
  - search

extra:
  version:
    provider: mike

markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - tables
  - toc:
      permalink: true
  - pymdownx.details
  - pymdownx.highlight
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true

extra_javascript:
  - https://unpkg.com/mermaid@10/dist/mermaid.min.js
  - javascripts/mermaid.js

nav:
  - Home: index.md
  - Getting Started:
      - Installation: getting-started/installation.md
      - Release candidate and evidence: release-candidate.md
      - Quick Start: getting-started/quickstart.md
      - CLI Overview: getting-started/cli-overview.md
  - User Guide:
      - Configuration: user-guide/configuration.md
      - Spec v2 Reference: user-guide/spec-v2-reference.md
      - Ordered Collections: user-guide/ordered-collections.md
      - Print-interior PDF: user-guide/print-interior-pdf.md
      - Supported Formats: user-guide/supported-formats.md
      - Tool Registry: user-guide/tool-registry.md
      - Adapter Ecosystem: user-guide/adapter-ecosystem.md
      - EPUB and KEPUB Derivatives: user-guide/ebook-derivatives.md
      - Fixed-layout EPUB: user-guide/fixed-layout-epub.md
      - Magazine Publications: user-guide/magazine-publications.md
      - Coloring-book Publications: user-guide/coloring-book-publications.md
      - LaTeX Components: user-guide/latex-components.md
      - Local Font Assets: user-guide/font-assets.md
      - Lulu Publication Pack: user-guide/lulu-publication-pack.md
      - Whole-file Video: handbrake-adapter.md
      - Super Resolution: user-guide/super-resolution.md
      - Upscayl Models: user-guide/upscayl-models.md
      - Pipelines: user-guide/pipelines.md
      - Transforms: user-guide/transforms.md
      - Optimization: user-guide/optimization.md
      - Caching: user-guide/caching.md
      - AI: user-guide/ai.md
      - Artifact DNA: user-guide/artifact-dna.md
      - Plugins: user-guide/plugins.md
      - Benchmarking: user-guide/benchmarking.md
      - Troubleshooting: user-guide/troubleshooting.md
      - FAQ: user-guide/faq.md
  - Architecture:
      - Universal Intake: universal-intake.md
      - Publication Hygiene: publication-hygiene.md
      - Overview: architecture/overview.md
      - Knowledge Base:
          - Identity:
              - Purpose: architecture/identity/PURPOSE.md
              - Vision: architecture/identity/VISION.md
              - Manifesto: architecture/identity/MANIFESTO.md
              - Principles: architecture/identity/PRINCIPLES.md
              - Pillars: architecture/identity/PILLARS.md
          - Foundation:
              - Methodology: architecture/foundation/METHODOLOGY.md
              - Foundations: architecture/foundation/FOUNDATIONS.md
              - System: architecture/foundation/SYSTEM.md
              - Architecture: architecture/foundation/ARCHITECTURE.md
              - Roadmap: architecture/foundation/ROADMAP.md
          - Domain:
              - Ontology: architecture/domain/ONTOLOGY.md
              - Personal Model: architecture/domain/PERSONAL_MODEL.md
          - Governance:
              - Decisions: architecture/governance/DECISIONS.md
          - Experience:
              - Design: architecture/experience/DESIGN.md
              - Design System: architecture/experience/DESIGN_SYSTEM.md
          - Meta:
              - AI Constitution: architecture/meta/AI_CONSTITUTION.md
              - Epistemology: architecture/meta/EPISTEMOLOGY.md
              - Meta: architecture/meta/META.md
      - Implementation Views:
          - Graph Engine: architecture/graph-engine.md
          - DAG Execution: architecture/dag-execution.md
          - Execution Evidence: execution-evidence.md
          - Resumable Provider Contract: provider-contract.md
          - Artifact Validation: user-guide/artifact-validation.md
          - Golden Conformance Corpus: conformance-corpus.md
          - Inspectable Artifact Gallery: artifact-gallery.md
          - Plugin Architecture: architecture/plugin-architecture.md
          - Execution Plans: architecture/execution-plans.md
  - CLI Reference:
      - Overview: cli-reference/index.md
      - build: cli-reference/build.md
      - watch: cli-reference/watch.md
      - inspect: cli-reference/inspect.md
      - audit: cli-reference/audit.md
      - graph: cli-reference/graph.md
      - plugin: cli-reference/plugin.md
      - ai: cli-reference/ai.md
      - dna: cli-reference/dna.md
      - font: cli-reference/font.md
      - tools & capabilities: cli-reference/tools.md
      - publication: cli-reference/publication.md
      - ebook: cli-reference/ebook.md
      - spec: cli-reference/spec.md
  - Transform Reference:
      - Overview: transform-reference/index.md
      - Emoji: transform-reference/emoji.md
      - Variables: transform-reference/variables.md
      - Syntax Highlight: transform-reference/syntax-highlight.md
  - Plugin Guide:
      - Overview: plugin-guide/overview.md
      - Developing: plugin-guide/developing.md
      - Transform v2 SDK: plugin-guide/v2-sdk.md
      - Transform v2 SDK: plugin-guide/v2-sdk.md
  - AI Guide:
      - Overview: ai-guide/overview.md
      - Configuration: ai-guide/configuration.md
      - Model catalog and skills: ai-guide/model-catalog-and-skills.md
  - Examples:
      - Hello World: examples/hello-world.md
      - Multi Output: examples/multi-output.md