mkdocs.yml

---
site_name: Revizor
site_url: https://github.com/microsoft/side-channel-fuzzer
site_author: Microsoft
site_description: A security-oriented tool for testing CPUs and detecting microarchitectural leaks like Spectre and Meltdown
copyright: 'Copyright © 2025 Microsoft'

repo_name: microsoft/side-channel-fuzzer
repo_url: https://github.com/microsoft/side-channel-fuzzer

docs_dir: docs

theme:
  name: material
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  font:
    text: Roboto
    code: Roboto Mono
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.indexes
    - navigation.tabs
    - toc.integrate
    - search.suggest
    - search.highlight
  logo: assets/icon.svg
  favicon: assets/favicon.svg

extra_css:
  - stylesheets/extra.css

plugins:
  - search

markdown_extensions:
  - toc:
      toc_depth: 2

  # diagrams
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format

  # Better typography and formatting
  - abbr
  - admonition
  - attr_list
  - md_in_html
  - def_list
  - footnotes
  - meta
  - tables
  - pymdownx.caret
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.details

  # Code highlighting (must be before tabbed)
  - pymdownx.highlight:
      anchor_linenums: true

  - pymdownx.snippets

  # Tabbed content blocks
  - pymdownx.tabbed:
      alternate_style: true
      combine_header_slug: true

  # Other extensions
  - pymdownx.pathconverter
  - pymdownx.tasklist:
      custom_checkbox: true

  # Enhanced formatting
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.tilde
  - pymdownx.smartsymbols

  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg


nav:
  - Start Here: intro/start-here.md
  - Documentation:
    - Documentation Structure: structure.md
    - Getting Started:
      - Revizor at a Glance: intro/01-overview.md
      - Installation: intro/02-install.md
      - Deep Dive into Concepts: intro/03-primer.md
      - Overview of Tutorials: intro/04-tutorials.md
      - Tutorial 1 - First Campaign: intro/tutorials/01-first-fuzz.md
      - Tutorial 2 - First Vulnerability: intro/tutorials/02-first-vuln.md
      - Tutorial 3 - Testing Faults: intro/tutorials/03-faults.md
      - Tutorial 4 - Testing Isolation: intro/tutorials/04-isolation.md
      - Tutorial 5 - Extending Revizor: intro/tutorials/05-extending.md
      - Extra Tutorial - Detecting TSA-SQ: intro/tutorials/tsa-sq.md
    - How-To Guides:
      - Ask a Question: howto/ask-a-question.md
      - Choose a Contract: howto/choose-contract.md
      - Design a Campaign: howto/design-campaign.md
      - Interpret Output: howto/interpret-results.md
      - Minimize Violations: howto/minimize.md
      - Root-Cause a Violation: howto/root-cause-a-violation.md
      - Use Templates: howto/use-templates.md
      - Use Macros: howto/use-macros.md
    - Topics:
      - Contracts: topics/contracts.md
      - Leakage Models: topics/models.md
      - Trace Analysis: topics/trace-analysis.md
      - Test Case Generation: topics/test-case-generation.md
      - Actors: topics/actors.md
    - Reference:
      - Modes of Operation: ref/modes.md
      - Command Line Interface: ref/cli.md
      - Configuration Options: ref/config.md
      - Runtime Statistics: ref/runtime-statistic.md
      - Minimization Passes: ref/minimization-passes.md
      - Macros: ref/macros.md
      - Artifact File Formats: ref/artifact-file-formats.md
      - Internal Binary Formats: ref/binary-formats.md
      - Registers: ref/registers.md
      - Sandbox: ref/sandbox.md
    - Glossary: glossary.md
    - Academic Research: ref/papers.md
  - FAQ:
    - General Questions: faq/general.md
  - Contribute:
    - Index: internals/index.md
    - Guide to Contributing: internals/contributing/overview.md
    - Guidelines:
      - General Guidelines: internals/contributing/general.md
      - Code Style: internals/contributing/code-style.md
      - Git Workflow: internals/contributing/git.md
    - Code Structure: internals/code-structure.md
    - Architecture:
      - Overview: internals/architecture/overview.md
      - Orchestration: internals/architecture/fuzz.md
      - ISA Specification: internals/architecture/isa.md
      - Test Case Code Generation: internals/architecture/code.md
      - Test Case Data Generation: internals/architecture/data.md
      - Hardware Tracing: internals/architecture/exec.md
      - Contract Tracing: internals/architecture/model.md
      - Trace Analysis: internals/architecture/analysis.md
      - Minimization: internals/architecture/mini.md
      - Logging: internals/architecture/logging.md
    - Model Backends:
      - Unicorn Backend: internals/model-backends/model-unicorn.md
      - DynamoRIO Backend: internals/model-backends/model-dr.md