mkdocs.yml

site_name: CANarchy
site_description: CLI-first CAN security research toolkit documentation
site_url: https://hexsecs.github.io/canarchy/docs/
repo_url: https://github.com/hexsecs/canarchy
repo_name: hexsecs/canarchy
site_dir: site/docs
extra_css:
  - stylesheets/extra.css

theme:
  name: material
  features:
    - navigation.sections
    - navigation.tabs
    - navigation.path
    - search.suggest
    - search.highlight
    - content.code.copy
  palette:
    - media: "(prefers-color-scheme: light)"
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
      scheme: default
      primary: blue grey
      accent: amber
    - media: "(prefers-color-scheme: dark)"
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
      scheme: slate
      primary: black
      accent: lime
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/theme-light-dark
        name: Use system theme
      scheme: default
      primary: blue grey
      accent: amber

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

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

nav:
  - Home: index.md
  - Getting Started: getting_started.md
  - User Guide:
      - Backends & Interfaces: backends.md
      - Project Overview: overview.md
      - Command Spec: command_spec.md
      - Event Schema: event-schema.md
      - CAN Tool Feature Matrix: feature-matrix.md
      - Security Use Cases With Agents: security-use-cases.md
      - Troubleshooting: troubleshooting.md
      - Plugin Author Guide: plugin-guide.md
  - Tutorials:
      - Overview: tutorials/index.md
      - Stream CAN Data from CANdid: tutorials/stream_candid_dataset.md
      - Launch the Web Dashboard: tutorials/web_dashboard.md
      - Discover and Use Provider-Backed DBC Files: tutorials/dbc_provider_workflow.md
      - J1939 Heavy Vehicle Analysis: tutorials/j1939_heavy_vehicle.md
      - Generate and Capture: tutorials/generate_and_capture.md
      - Simulate Vehicle Traffic: tutorials/simulate_vehicle_traffic.md
  - Cookbook:
      - Overview: cookbook/index.md
      - Filter for a single arbitration ID or PGN: cookbook/filter-pgn.md
      - Decode SPN 110 (engine coolant temperature): cookbook/decode-spn-110.md
      - Find counter signals in a capture: cookbook/find-counter-signals.md
      - Fuzz Tesla DI_torque2 vehicle speed: cookbook/fuzz-tesla-di-torque2-speed.md
      - Match an unknown capture against opendbc: cookbook/match-dbc-against-capture.md
      - Acquire a bounded dataset slice for offline analysis: cookbook/acquire-dataset-slice.md
      - Stream the CANdid dataset into stats: cookbook/stream-candid-into-stats.md
      - Stream commaCarSegments CAN data: cookbook/stream-comma-car-segments.md
      - Wire CANarchy into Claude Desktop or Claude Code: cookbook/mcp-claude-integration.md
      - Run and analyze a simulated vehicle traffic profile: cookbook/simulate-vehicle-profiles.md
      - Build a virtual CAN loop for offline testing: cookbook/virtual-can-loop.md
      - Verify a PCAN interface in 30 seconds: cookbook/verify-pcan-interface.md
      - Verify a Vector interface in 30 seconds: cookbook/verify-vector-interface.md
      - Verify a Kvaser interface in 30 seconds: cookbook/verify-kvaser-interface.md
      - Compare two captures for DM1 fault diffs: cookbook/compare-dm1-faults.md
      - Analyze a capture from a UTHP / TCAT appliance: cookbook/analyze-tcat-capture.md
  - Developers:
      - Architecture: architecture.md
      - Docs Workflow: docs_site.md
      - Release Workflow: release.md
      - TUI Plan: tui_plan.md
      - Spec Template: spec-template.md
      - Design Specs:
          - Active Command Safety: design/active-command-safety.md
          - Active-Transmit Safety Model: design/active-transmit-safety.md
          - Response-Feedback Guided Fuzzing: design/response-feedback-fuzz.md
          - Fuzz Culprit Identification: design/fuzz-identify.md
          - Transport Core Commands: design/transport-core-commands.md
          - DBC Command Workflows: design/dbc-command-workflows.md
          - DBC Inspect Command: design/dbc-inspect-command.md
          - DBC Provider Workflows: design/dbc-provider-workflows.md
          - DBC Runtime and Schema Split: design/dbc-runtime-schema-split.md
          - Generate Command: design/generate-command.md
          - Simulate Command: design/simulate-command.md
          - Gateway Command: design/gateway-command.md
          - Export Command: design/export-command.md
          - Config Show Command: design/config-show-command.md
          - Standalone ISO-TP Utility Commands: design/isotp-utility-commands.md
          - Expanded J1939 Workflows: design/j1939-expanded-workflows.md
          - J1939 Monitor Command: design/j1939-monitor-command.md
          - J1939 Map Command: design/j1939-map-command.md
          - Scapy Diagnostic Integration: design/scapy-diagnostic-integration.md
          - Skill Manifest Schema: design/skill-manifest-schema.md
          - Skills Agent MCP Integration: design/skills-agent-mcp-integration.md
          - Skills Provider Workflows: design/skills-provider-workflows.md
          - Composition: design/composition.md
          - MCP Server: design/mcp-server.md
          - Reverse-Engineering Helpers: design/reverse-engineering-helpers.md
          - RE Suggest: design/re-suggest.md
          - Replay Command: design/replay-command.md
          - Session Workflows: design/session-workflows.md
          - UDS Transaction Workflows: design/uds-transaction-workflows.md
          - UDS Services Command: design/uds-services-command.md
          - Active UDS Workflows: design/uds-active-workflows.md
          - DoIP Diagnostic Workflows: design/doip-diagnostic-workflows.md
          - XCP Workflows: design/xcp-workflows.md
          - J1587/J1708 Decode: design/j1587-decode.md
          - J2497 (PLC4TRUCKS) Decode: design/j2497-decode.md
          - Shell Command: design/shell-command.md
          - TUI Shell: design/tui-shell.md
          - Web Dashboard: design/web-serve.md
          - cannelloni Interop: design/cannelloni-interop.md
      - Test Specs:
          - Active Command Safety: tests/active-command-safety.md
          - Active-Transmit Safety Model: tests/active-transmit-safety.md
          - Response-Feedback Guided Fuzzing: tests/response-feedback-fuzz.md
          - Fuzz Culprit Identification: tests/fuzz-identify.md
          - Transport Core Commands: tests/transport-core-commands.md
          - DBC Command Workflows: tests/dbc-command-workflows.md
          - DBC Inspect Command: tests/dbc-inspect-command.md
          - DBC Provider Workflows: tests/dbc-provider-workflows.md
          - Generate Command: tests/generate-command.md
          - Simulate Command: tests/simulate-command.md
          - Gateway Command: tests/gateway-command.md
          - Export Command: tests/export-command.md
          - Config Show Command: tests/config-show-command.md
          - Standalone ISO-TP Utility Commands: tests/isotp-utility-commands.md
          - Expanded J1939 Workflows: tests/j1939-expanded-workflows.md
          - J1939 Monitor Command: tests/j1939-monitor-command.md
          - J1939 Map Command: tests/j1939-map-command.md
          - Scapy Diagnostic Integration: tests/scapy-diagnostic-integration.md
          - Skill Manifest Schema: tests/skill-manifest-schema.md
          - Skills Agent MCP Integration: tests/skills-agent-mcp-integration.md
          - Skills Provider Workflows: tests/skills-provider-workflows.md
          - MCP Server: tests/mcp-server.md
          - Reverse-Engineering Helpers: tests/reverse-engineering-helpers.md
          - RE Suggest: tests/re-suggest.md
          - Replay Command: tests/replay-command.md
          - Session Workflows: tests/session-workflows.md
          - UDS Transaction Workflows: tests/uds-transaction-workflows.md
          - UDS Services Command: tests/uds-services-command.md
          - Active UDS Workflows: tests/uds-active-workflows.md
          - DoIP Diagnostic Workflows: tests/doip-diagnostic-workflows.md
          - XCP Workflows: tests/xcp-workflows.md
          - J1587/J1708 Decode: tests/j1587-decode.md
          - J2497 (PLC4TRUCKS) Decode: tests/j2497-decode.md
          - Shell Command: tests/shell-command.md
          - TUI Shell: tests/tui-shell.md
          - Web Dashboard: tests/web-serve.md
          - cannelloni Interop: tests/cannelloni-interop.md
          - Composition: tests/composition.md
  - Agents:
      - Agent Guide: agents.md
      - MCP Install: mcp_install.md

strict: true