thingsflow/mkdocs.yml at main · lirei-lab/thingsflow · 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
site_name: ThingsFlow
site_url: https://lirei.ca/thingsflow/
site_description: Open industrial IoT middleware for event-driven telemetry, digital twins, data-plane alarms, and optional ThingsBoard UI compatibility.
repo_url: https://github.com/lirei-lab/thingsflow
repo_name: lirei-lab/thingsflow
edit_uri: edit/main/docs/

# The config lives at the repo root (mkdocs 2.x refuses a docs_dir that is the
# parent of the config file); the documentation tree stays under docs/.
docs_dir: docs
site_dir: site

exclude_docs: |
  README.md
  requirements.txt
  superpowers/**
  archive/**

# Broken internal links used to be silenced; they now surface as warnings, which
# `mkdocs build --strict` (CI) turns into failures. Links to repo files outside the
# docs tree must be absolute GitHub URLs so they resolve on the published site.
validation:
  nav:
    omitted_files: ignore
  links:
    not_found: warn
    unrecognized_links: warn
    anchors: warn

theme:
  name: material
  language: en
  features:
    - navigation.sections
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.share
    - content.code.copy
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: teal
      accent: blue
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: teal
      accent: blue
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
  icon:
    repo: fontawesome/brands/github

plugins:
  - search

markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - tables
  - toc:
      permalink: true
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format

nav:
  - Home: index.md
  - Overview:
      - Architecture: ARCHITECTURE.md
      - Roadmap: ROADMAP.md
  - Getting Started:
      - Quickstart: GETTING_STARTED.md
      - Demo Profile: DEMO_PROFILE.md
      - Install: INSTALL.md
  - Concepts:
      - Digital Twin: DIGITAL_TWIN.md
  - Messaging:
      - Data Plane: DATA_PLANE.md
      - Edge Gateway: EDGE_GATEWAY.md
  - API And Provisioning:
      - API Reference: API_REFERENCE.md
      - UI Contract Coverage: UI_CONTRACT_COVERAGE.md
      - UI Contract Data Fidelity: UI_CONTRACT_DATA_FIDELITY.md
      - Device SDK: DEVICE_SDK.md
      - MQTT Device Auth: MQTT_DEVICE_AUTH.md
  - Security And Operations:
      - Security Architecture: SECURITY.md
      - Operations: OPERATIONS.md
  - Release:
      - Release: RELEASE.md
  - Decisions:
      - "ADR-0001: Edge store-and-forward backfill": adr/0001-edge-store-and-forward-backfill.md
      - "ADR-0002: TB UI contract data-fidelity audit": adr/0002-ui-contract-data-fidelity-audit.md
      - "ADR-0003: NATS consumer liveness guard": adr/0003-nats-consumer-progress-guard.md