labwired-core/mkdocs.yml at main · layer1labs/labwired-core · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
site_name: LabWired Core
site_url: https://docs.labwired.com/
repo_url: https://github.com/w1ne/labwired-core
repo_name: w1ne/labwired-core

theme:
  name: material
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - toc.follow
    - search.suggest
    - search.highlight
    - content.code.copy
  palette:
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  font:
    text: Roboto
    code: Roboto Mono

markdown_extensions:
  - 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
  - admonition
  - pymdownx.details
  - attr_list
  - md_in_html

plugins:
  - search

nav:
  - Home: index.md
  - Architecture Overview: architecture.md
  - Hardware-Sim Parity: golden_reference.md
  - AI Agent Manual: agents.md

  - Tutorials:
    - Running Firmware: getting_started_firmware.md
    - Simulating Sensors (I2C): examples/i2c_sensor_example.md
    - Mastering DMA & Interrupts: examples/dma_exti_example.md
    - Integrated Test Walkthrough: examples/integrated_test_walkthrough.md

  - How-To Guides:
    - Board Onboarding: board_onboarding_playbook.md
    - CI/CD Integration: ci_integration.md
    - Peripheral Modeling: peripherals.md
    - Hardware Interaction Guide: hardware_interaction_guide.md
    - Debugging with VS Code: vscode_debugging.md
    - GDB Integration: gdb_integration.md
    - Troubleshooting: troubleshooting.md
    - Debugging: debugging.md
    - PlatformIO Integration: platformio_integration.md
    - Co-simulation Plugins: cosimulation_plugins.md
    - CI Integration Templates: integration-templates/README.md

  - Reference:
    - Configuration (YAML): configuration_reference.md
    - Declarative Registers: declarative_registers.md
    - CLI Commands: cli_reference.md
    - Test Script Schema: ci_test_runner.md
    - Client Flows: reference_client_flows.md
    - ISA Coverage: isa_coverage.md
    - Schema Compatibility: schema_compatibility.md
    - Catalog Validation: catalog_validation.md
    - Target Support Rubric: target_support_rubric.md

  - Boards:
    - STM32F103: boards/stm32f103.md
    - STM32F401: boards/stm32f401.md
    - STM32F407: boards/stm32f407.md
    - NUCLEO-L476RG: boards/nucleo-l476rg.md
    - STM32H563: boards/stm32h563.md
    - STM32H735: boards/stm32h735.md
    - STM32WBA52: boards/stm32wba52.md
    - nRF52832: boards/nrf52832.md
    - nRF52840: boards/nrf52840.md
    - RP2040: boards/rp2040.md
    - ESP32-C3: boards/esp32c3.md
    - ESP32-S3: boards/esp32s3.md
    - nRF5340: boards/nrf5340.md
    - nRF54L15: boards/nrf54l15.md
    - NUCLEO-L073RZ: boards/nucleo-l073rz.md
    - XIAO nRF52840 Sense: boards/seeed-xiao-nrf52840-sense.md

  - Operations:
    - Release Strategy: release_strategy.md
    - Release Determinism: RELEASE_DETERMINISM.md
    - Verification Audit: labwired_audit_protocol.md
    - Coverage Scoreboard: coverage_scoreboard.md
    - Chip Conformance (live): coverage/chip-conformance.md
    - Tier-1 Matrix (live): coverage/tier1-scoreboard.md
    - Arduino Scoreboard: coverage/arduino-scoreboard.md
    - Zephyr Scoreboard: coverage/zephyr-scoreboard.md
    - Test Harness: engineering/test_harness.md
    - Run Limits: limits.md
    - Demos: demos.md
    - Case Study (STM32): case_study_stm32.md

  - Explanation:
    - Architecture Overview: architecture_overview.md
    - Simulation Protocol: simulation_protocol.md