mkdocs.yml

site_name: BESSAI Edge Gateway
site_description: Open-source industrial BESS gateway — IEEE 2030.5, IEC 62443 SL-2, DRL arbitrage, mTLS OT, MQTT, ONNX edge inference.
site_url: https://bess-solutions.github.io/open-bess-edge/
repo_url: https://github.com/bess-solutions/open-bess-edge
repo_name: bess-solutions/open-bess-edge
copyright: Copyright © 2024-2026 BESS Solutions — Apache 2.0 License

theme:
  name: material
  logo: assets/logo.png
  favicon: assets/favicon.png
  language: en
  palette:
    - scheme: slate
      primary: indigo
      accent: cyan
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
    - scheme: default
      primary: indigo
      accent: cyan
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.indexes
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.annotate
    - toc.follow
  font:
    text: Inter
    code: Roboto Mono

plugins:
  - search:
      lang: en
  - minify:
      minify_html: true

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - attr_list
  - md_in_html
  - tables
  - toc:
      permalink: true

nav:
  - Home: index.md
  - "📍 Para Adopters":
    - Adopter Hub (empieza aquí): ADOPTER_HUB.md
    - Onboarding Día 0 → 7: ONBOARDING_7DAYS.md
    - FAQ Técnica: FAQ.md
    - Contribuir (primer PR): CONTRIBUTING_ADOPTERS.md
    - Programa Early Adopters: early_adopters.md
    - Pilot Guide (Chile/CEN): PILOT_GUIDE.md
  - Getting Started:
    - Quick Start (5 min): tutorials/quickstart_5min.md
    - Local Development: local_development.md
    - Raspberry Pi 4/5: quickstart_rpi.md
  - Tutorials:
    - Conectar Hardware Real: tutorials/connecting_real_hardware.md
    - MQTT + Home Assistant: tutorials/integration_homeassistant.md
    - MQTT Integration (full): mqtt_integration.md
  - Architecture:
    - Overview: architecture.md
    - Sim-First Strategy: simulation_registry.md
    - Roadmap v2.7–3.0: ROADMAP.md
    - 🚀 AI Roadmap 20/10: ai_roadmap_20_10.md
    - 🔍 AI Audit Report: ai_audit_report.md
    - 🧬 BESSAIEvolve — AlphaEvolve: BESSAI_EVOLVE.md
    - Decision Records (ADRs):
      - Overview: adr/README.md
      - ADR-001 Pydantic Settings: adr/0001-pydantic-settings-config.md
      - ADR-002 Modbus Encoding: adr/0002-struct-modbus-encoding.md
      - ADR-003 IDS Anomaly: adr/0003-isolation-forest-anomaly-detection.md
      - ADR-004 ONNX Inference: adr/0004-onnx-offline-inference.md
      - ADR-005 GCP Pub/Sub: adr/0005-gcp-pubsub-telemetry.md
      - ADR-007 JSON Schema Spec: adr/0007-json-schema-telemetry-specification.md
      - ADR-008 BEP Process: adr/0008-bep-process-for-specification-changes.md
  - Specifications (BESSAI-SPEC):
    - SPEC-001 BESSDriver Interface: specs/BESSAI-SPEC-001.md
    - SPEC-002 Safety Requirements: specs/BESSAI-SPEC-002.md
    - SPEC-003 Telemetry Schema: specs/BESSAI-SPEC-003.md
    - SPEC-004 BMS Data Model (IEEE 2686): specs/BESSAI-SPEC-004.md
  - Enhancement Proposals (BEPs):
    - BEP-0001 — BEP Process: bep/BEP-0001.md
    - BEP-0100 — IEEE 2030.5 Adapter: bep/BEP-0100.md
    - BEP-0200 — DRL Arbitrage Agent: bep/BEP-0200.md
    - BEP-0202 — Protocol Registry: bep/BEP-0202.md
    - BEP-0300 — DRL Autonomous Control: bep/BEP-0300.md
    - BEP-0301 — XAI — Explainable AI: bep/BEP-0301.md
    - BEP-0302 — Market Integration CMg Live: bep/BEP-0302.md
    - BEP-0303 — BESSAIEvolve (Self-Improvement): bep/BEP-0303.md
  - API Reference:
    - External Interface (API): API.md
    - API Reference (Legacy): api_reference.md
  - Operations:
    - Runbook: runbook.md
  - Security & Compliance:
    - NTSyCS Compliance: compliance/ntscys_compliance.md
    - IEC 62443 Mapping: compliance/iec62443_mapping.md
    - IEC 62443 SL-2 Gap: compliance/iec62443_sl2_gap.md
    - IEC 62443 SL-2 Path: compliance/iec_62443_sl2_certification_path.md
    - System Security Plan (SSP-001): compliance/ssp_iec62443_sl2.md
    - Network Architecture (NAD-001): architecture/network_diagram.md
    - Patch Management SLA (PMS-001): compliance/patch_management_sla.md
    - PSIRT Process: compliance/psirt_process.md
    - IEEE 2030.5 Gap Analysis: compliance/ieee_2030_5_compliance.md
    - OCPP 2.0.1 V2G Compatibility: compliance/OCPP_compatibility.md
  - Interoperability:
    - Interop Test Suite: interoperability/interop_test_suite.md
    - BESSAI Certified Program: interoperability/BESSAI-CERTIFIED.md
    - OpenFMB Adapter Guide: interoperability/openFMB_adapter.md
    - Battery Data Format (BDF): interoperability/BDF_alignment.md
  - Community:
    - Adopters: adopters.md
    - Good First Issues: GOOD_FIRST_ISSUES.md
    - Academic Collaboration: academic_collaboration.md
    - Research Topics: research_topics.md
  - Benchmarks:
    - BENCHMARK-001 Latency: benchmarks/BENCHMARK-001-latency.md
    - BENCHMARK-002 Scale: benchmarks/BENCHMARK-002-scale.md
    - BENCHMARK-003 Security: benchmarks/BENCHMARK-003-security.md
    - BENCHMARK-004 DRL Arbitrage: benchmarks/BENCHMARK-004-drl-arbitrage.md
    - BENCHMARK-005 Edge Devices: benchmarks/BENCHMARK-005-edge-devices.md
  - Development:
    - Release Process: release_process.md
    - Security Guide (Maintainer): security_guide_maintainer.md
    - Hardware Profile Tutorial: tutorials/hardware_profile_contribution.md
    - DRL Training Custom: tutorials/training_custom_drl.md

extra:
  social:
    - icon: fontawesome/brands/discord
      link: https://discord.gg/ZqpE8AZs
      name: BESSAI Community Discord
    - icon: fontawesome/brands/github
      link: https://github.com/bess-solutions/open-bess-edge
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/company/bess-solutions
  version:
    provider: mike

extra_css:
  - stylesheets/extra.css