mia/mkdocs.yml at main · sparesparrow/mia · 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
site_name: AI-SERVIS Documentation
site_description: Modular Car AI Server — Android-first with ESP32 and optional Pi gateway
repo_url: https://github.com/sparesparrow/mia-universal
repo_name: sparesparrow/mia-universal
site_url: https://sparesparrow.github.io/mia-universal/

theme:
  name: material
  language: en
  features:
    - navigation.tabs
    - navigation.indexes
    - navigation.expand
    - search.highlight
    - content.code.copy
    - content.action.edit
  palette:
    - scheme: default
      primary: indigo
      accent: indigo
    - scheme: slate
      primary: indigo
      accent: indigo
  icon:
    repo: fontawesome/brands/github

# ─── Validation ───────────────────────────────────────────────────────────────
# broken relative links in legacy docs point to files that don't exist yet;
# downgrade those to info so --strict doesn't fail the build.
# omitted_files: info  — two misc/ files with special-char names are excluded from
# nav because YAML cannot reliably represent their filenames; they are still built.
validation:
  nav:
    omitted_files: info      # files in docs/ not listed in nav → info, not warn
    not_found: warn          # nav entries pointing to missing files → keep strict
  links:
    not_found: ignore
    unrecognized_links: ignore
    absolute_links: ignore

# ─── Navigation ───────────────────────────────────────────────────────────────
nav:
  - Overview: index.md

  - Getting Started:
    - Quick Start: getting-started/QUICK_START.md
    - Android Device Setup: android-device-setup.md

  - Architecture:
    - System Overview: architecture/overview.md
    - Diagrams: architecture/diagrams.md
    - Hybrid Messaging: architecture/hybrid-messaging.md
    - Lean Architecture: architecture/lean-architecture.md
    - FlatBuffers Schema: architecture/flatbuffers-schema-guide.md
    - Voice Knowledge Integration: architecture/voice-knowledge-mia-integration.md
    - Voice Knowledge Implementation: architecture/voice-knowledge-system-implementation-guide.md
    - Voice Knowledge System: architecture/VOICE_KNOWLEDGE_SYSTEM_README.md
    - Architecture Index: architecture/README.md

  - Install:
    - Phone Edition: install/phone.md
    - Hybrid Edition: install/hybrid.md
    - Pro Edition: install/pro.md
    - Pi Gateway (Standalone): install/pi-gateway.md
    - Dev (No Pi): install/dev-docker.md
    - Installer Checklist: install/installer-checklist.md

  - Deployment:
    - Deployment Index: deployment/README.md
    - Complete Deployment Guide: deployment/COMPLETE_DEPLOYMENT_GUIDE.md
    - Raspberry Pi: deployment/raspberry-pi.md
    - Production Deployment: PRODUCTION_DEPLOYMENT.md
    - Raspberry Pi Setup: RASPBERRY_PI_SETUP.md

  - Automotive:
    - Quick Start: AUTOMOTIVE_QUICK_START.md
    - Citroën Integration: automotive/citroen-integration.md
    - Citroën Testing Checklist: automotive/citroen-testing-checklist.md
    - OBD Simulator Automation: OBD_SIMULATOR_AUTOMATION.md
    - ZeroMQ Message Formats: ZEROMQ_MESSAGE_FORMATS.md

  - Modules:
    - AI Audio Assistant: modules/ai-audio-assistant.md
    - AI Android Controller: modules/ai-android-controller.md
    - AI iOS Controller: modules/ai-ios-controller.md
    - AI Linux Controller: modules/ai-linux-controller.md
    - AI macOS Controller: modules/ai-macos-controller.md
    - AI Windows Controller: modules/ai-windows-controller.md
    - AI RTOS Controller: modules/ai-rtos-controller.md
    - AI Communications: modules/ai-communications.md
    - AI Home Automation: modules/ai-home-automation.md
    - AI Maps & Navigation: modules/ai-maps-navigation.md
    - AI Security & ANPR: modules/ai-security-anpr.md

  - API & Contracts:
    - Overview: api/overview.md
    - Changelog: api/changelog.md
  - Automotive:
    - Quick Start: AUTOMOTIVE_QUICK_START.md
    - Citroen Integration: automotive/citroen-integration.md
    - Audi on Raspberry Pi: automotive/raspberry-pi-audi-integration.md
  - Privacy:
    - DPIA Template: privacy/dpia-template.md
  - Troubleshooting: troubleshooting.md

plugins:
  - search
  - mermaid2

markdown_extensions:
  - admonition
  - attr_list
  - pymdownx.superfences
  - pymdownx.highlight
  - pymdownx.inlinehilite

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/sparesparrow/mia