mkdocs.yml

site_name: fsmc Documentation
site_description: Universal State Machine Compiler, Formal Verification & Zero-Overhead C++ Engine
site_author: Simone Cavalleri
site_url: https://simoneCavalleri.github.io/fsmc/
repo_url: https://github.com/simoneCavalleri/fsmc
repo_name: simoneCavalleri/fsmc
edit_uri: edit/main/docs/

theme:
  name: material
  custom_dir: overrides
  logo: assets/logo.svg
  favicon: assets/logo.svg


  font:
    text: IBM Plex Sans
    code: JetBrains Mono
  palette:
    - scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.indexes
    - navigation.path
    - navigation.tracking
    - navigation.top
    - navigation.footer
    - search.suggest
    - search.highlight
    - search.share
    - content.code.copy
    - content.code.annotate
    - content.tabs.link
    - toc.follow


extra_css:
  - stylesheets/extra.css

extra_javascript:
  - javascripts/mathjax.js
  - https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js

plugins:
  - search

validation:
  nav:
    omitted_files: ignore
  links:
    not_found: ignore
    absolute_links: ignore
    unrecognized_links: ignore

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
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.keys
  - pymdownx.arithmatex:
      generic: true
  - attr_list
  - md_in_html
  - tables
  - toc:
      permalink: true
      toc_depth: 3

nav:
  - Overview: index.md

  - Getting Started:
      - Introduction: getting_started/index.md
      - Installation & Requirements: getting_started/installation.md
      - Quickstart Tutorial: getting_started/quickstart.md
      - Quick Reference (Cheat Sheet): getting_started/quick_reference.md
      - Build Systems Integration: getting_started/integration_guide.md
      - Interactive Web Playground: playground/index.md

  - Systems Modeling & Safety:
      - Introduction: formal_languages/index.md
      - Modeling Languages:
          - OMG SysML v2: formal_languages/sysml_v2.md
          - Cameo / MagicDraw: formal_languages/cameo_magicdraw.md
          - W3C SCXML: formal_languages/scxml.md
          - nuXmv / SMV Logic: formal_languages/smv_nuxmv.md
          - Visual Diagrams: formal_languages/diagrams.md
          - UML Specification Reference: formal_languages/uml_reference.md
      - Formal Verification:
          - Verification Overview: verification_and_safety/index.md
          - Model Checking (LTL/CTL): verification_and_safety/model_checking.md
          - EFSM Interval Analysis: verification_and_safety/interval_analysis.md
          - Requirement Traceability (RTM): verification_and_safety/rtm_matrix.md

  - Target Backends & Runtimes:
      - Overview & Target Matrix: runtime_api/index.md
      - C++ Reference Backend:
          - Core Building Blocks: runtime_api/core_concepts.md
          - Policy-Based Configuration: runtime_api/policy_configuration.md
          - Execution Engines:
              - Synchronous Engine (fsm): runtime_api/synchronous_fsm.md
              - Lock-Free SPSC (spsc_fsm): runtime_api/spsc_fsm.md
              - Active Object (thread_safe): runtime_api/thread_safe_fsm.md
          - Real-Time & Reliability:
              - Memory Layout & WCET: runtime_api/memory_and_realtime.md
              - Tracing & Telemetry: runtime_api/introspection_trace.md
              - Architectural Design Patterns: runtime_api/design_patterns.md
      - Multi-Target Roadmap: runtime_api/multi_target_roadmap.md

  - Tutorials & Practical Guides:
      - Tutorials Overview: tutorials/index.md
      - Step-by-Step Tutorials:
          - 1. First State Machine: tutorials/01_first_statechart.md
          - 2. EFSM & Datapath: tutorials/02_guards_and_actions.md
          - 3. HFSM & History: tutorials/03_hierarchical_hfsm.md
          - 4. Formal Verification: tutorials/04_formal_verification.md
          - 5. Codegen & Integration: tutorials/05_code_generation_and_integration.md
          - 6. UAV Flight Controller: tutorials/06_real_world_case_study.md
      - Practical Guides:
          - Unit Testing Guide: runtime_api/testing_guide.md
          - Troubleshooting & FAQ: runtime_api/faq_and_troubleshooting.md

  - Technical Reference:
      - Overview: reference/index.md
      - CLI Reference (fsmc): getting_started/cli_usage.md
      - C++ Runtime API Reference: runtime_api/reference.md
      - CMake Build Integration: reference/cmake_integration.md
      - Canonical IR Specification: internals/fsm_ir_specification.md
      - Test Suite Catalog: reference/test_suite_catalog.md

  - Architecture & Internals:
      - Overview: internals/index.md
      - Theoretical Concepts:
          - Concepts Overview: concepts/index.md
          - Execution Semantics: concepts/execution_semantics.md
          - Dual-Paradigm Models: concepts/temporal_models.md
          - States & HFSM Hierarchy: concepts/states_and_hierarchy.md
          - Transitions & Triggers: concepts/transitions_and_events.md
          - Guards & Action Effects: concepts/guards_and_actions.md
      - Compiler Infrastructure:
          - Pipeline & Subsystems: internals/architecture.md
          - Developer Guide: internals/developer_guide.md
          - Contributing Guide: contributing/index.md