mkdocs.yml

Rama main · réplica de lectura del repositorio original.

site_name: soc-ai
site_description: >-
  Self-hosted LLM alert triage for Security Onion. The model runs on your
  own hardware, and no data leaves your network by default.
site_url: https://nuk3s.github.io/soc-ai/
repo_url: https://github.com/nuk3s/soc-ai
repo_name: nuk3s/soc-ai
edit_uri: edit/main/docs/
copyright: Apache-2.0 · Not affiliated with or endorsed by Security Onion Solutions, LLC.

# The docs live alongside the code in docs/. docs/dev/ is internal-only and must
# never be published — exclude_docs keeps it (and stray editor files) out of the
# built site regardless of nav. Verify with: mkdocs build --strict && test that
# site/dev does not exist.
docs_dir: docs
exclude_docs: |
  dev/
  demo/
  superpowers/
  *.src.html

theme:
  name: material
  language: en
  logo: img/logo-square.png
  favicon: img/logo-square.png
  icon:
    repo: fontawesome/brands/github
  palette:
    # Light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: blue
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    # Dark mode (matches the product's dark aesthetic)
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: blue
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
  features:
    - navigation.instant
    - navigation.instant.progress
    - navigation.sections
    - navigation.top
    - navigation.tracking
    - navigation.footer
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.tabs.link
    - toc.follow

markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - tables
  - footnotes
  - toc:
      permalink: true
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - 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
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

plugins:
  - search

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/nuk3s/soc-ai
      name: soc-ai on GitHub

nav:
  - Home: index.md
  - Installation:
      - Quickstart: quickstart.md
      - Security Onion setup: SECURITY-ONION-SETUP.md
      - Docker deployment: DOCKER.md
      - Bare-metal deployment: DEPLOYMENT.md
      - Blocklists: BLOCKLISTS.md
      - Sensor PCAP setup: SENSOR_PCAP_SETUP.md
  - Operation:
      - Console guide: WEBUI_GUIDE.md
      - Hunting: HUNTING.md
      - Agent tools: AGENT_TOOLS.md
      - OQL primer: OQL_PRIMER.md
      - OQL hunting examples: OQL_HUNT_EXAMPLES.md
      - Test PCAPs: TEST_PCAPS.md
  - Design:
      - Architecture: ARCHITECTURE.md
      - Safety model: SAFETY_MODEL.md
      - Audit chain breaks: AUDIT-CHAIN.md
      - Lesser models: LESSER_MODELS.md
  - Blog:
      - soc-ai hunts on its own now: blog/2026-10-soc-ai-hunts-on-its-own-now.md
      - Getting an LLM to show its work: blog/2026-07-getting-an-llm-to-show-its-work.md
  - Project:
      - Roadmap: ROADMAP.md
      - Release notes 1.6.0: releases/1.6.0.md
      - Release notes 1.5.3: releases/1.5.3.md
      - Release notes 1.5.2: releases/1.5.2.md
      - Release notes 1.5.1: releases/1.5.1.md
      - Release notes 1.5.0: releases/1.5.0.md
      - Changelog: project/changelog.md
      - Contributing: project/contributing.md
      - Security policy: project/security.md