mkdocs.yml

site_name: Issen
site_url: https://securityronin.github.io/issen/
repo_url: https://github.com/SecurityRonin/issen
repo_name: SecurityRonin/issen
edit_uri: edit/main/docs/

theme:
  name: material
  logo: assets/issen-icon-128.png
  favicon: assets/favicon.ico
  palette:
    - scheme: default
      primary: red
      accent: deep orange
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: red
      accent: deep orange
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - content.code.copy
    - navigation.tabs
    - navigation.sections
    - navigation.top
    - search.highlight

markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.highlight:
      anchor_linenums: true
  - tables
  - toc:
      permalink: true

nav:
  - Home: index.md
  - Architecture: architecture-diagram.html
  - Quickstart: szechuan-sauce-quickstart.md
  - Design & Internals:
      - System Architecture: ARCHITECTURE.md
      - Issen vs Plaso: issen-vs-plaso-architecture.md
      - Selective Decompression (Triage): selective-decompression-triage.md
      - Writing Disk-Image Crates: writing-disk-image-crates.md
      - "DRY — Shared Crates": dry-analysis-shared-crates.md
      - CLI Front-Door Spec: cli-unified-frontdoor-spec.md
      - Remote Sources: remote-sources.md
  - Decision Records (ADRs):
      - Overview: decisions/README.md
      - "0001 · Multi-repo fleet & five primitives": decisions/0001-multi-repo-fleet-five-navigation-primitives.md
      - "0002 · forensicnomicon & report model": decisions/0002-forensicnomicon-knowledge-leaf-and-report-model.md
      - "0003 · core reader / forensic analyzer split": decisions/0003-core-reader-forensic-analyzer-split.md
      - "0004 · CollectionProvider for logical containers": decisions/0004-collectionprovider-for-logical-containers.md
      - "0005 · DuckDB timeline store + Appender": decisions/0005-duckdb-timeline-store-columnar-appender.md
      - "0006 · Pure-Rust container reading (zip-direct, zran)": decisions/0006-pure-rust-container-reading-zip-and-zran.md
      - "0007 · Resumable ingestion (content fingerprint)": decisions/0007-resumable-ingestion-content-fingerprint.md
      - "0008 · Fail loud on unsupported filesystem": decisions/0008-fail-loud-on-unsupported-filesystem.md
      - "0009 · Batteries-included single static binary": decisions/0009-batteries-included-single-static-binary.md
      - "0010 · disk-forensic as disk-image access abstraction (Proposed)": decisions/0010-disk-forensic-as-disk-image-access-abstraction.md
  - Reference:
      - Validation: validation.md
      - Correlation Validation: validation-correlate.md
      - Format Coverage Audit: format-coverage-audit.md
      - Test Corpus Catalog: corpus-catalog.md
      - Fleet Atlas: fleet-atlas.md
      - Fleet Capability Inventory: fleet-capability-inventory.md
      - Forensicnomicon Convergence Plan: fleet-fn-convergence-plan.md
  - Privacy Policy: privacy.md
  - Terms of Service: terms.md

plugins:
  - search

# Raw HTML files in docs/ (e.g. architecture-diagram.html) are copied
# to site/ as-is by MkDocs and can be linked directly from markdown.
# use_directory_urls must be false so relative links like
# architecture-diagram.html resolve correctly.
use_directory_urls: false