edge-system-qualification/mkdocs.yml at main · open-edge-platform/edge-system-qualification · 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
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
site_name: Intel® Edge System Qualification
site_url: https://open-edge-platform.github.io/edge-system-qualification/
site_description: >-
  A comprehensive framework for testing and evaluating edge computing systems.
  Provides automated test suites, system validation, and detailed reporting
  for Intel edge platforms.
repo_name: open-edge-platform/edge-system-qualification
repo_url: https://github.com/open-edge-platform/edge-system-qualification
docs_dir: docs/

# Copyright
copyright: Copyright &copy; 2025 Intel Corporation

# Configuration
theme:
  name: material
  custom_dir: docs/overrides
  language: en
  palette:
    - scheme: default
      primary: white
      accent: white
  favicon: assets/images/logo.svg
  font:
    text: Roboto
    code: Roboto Mono

  # Features
  features:
    - announce.dismiss
    - content.action.edit
    - content.action.view
    - content.code.annotate
    - content.code.copy
    - content.tabs.link
    - content.tooltips
    - navigation.expand
    - navigation.footer
    - navigation.indexes
    - navigation.instant
    - navigation.instant.prefetch
    - navigation.sections
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow

# Custom color schemes
extra_css:
- stylesheets/extra.css

# Plugins
plugins:
  - search:
      separator: '[\s\-,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
  - mike:
      alias_type: symlink
      redirect_template: null
      deploy_prefix: ''
      canonical_version: null
      version_selector: true
      css_dir: css
      javascript_dir: js

# Customization
extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/open-edge-platform/edge-system-qualification
  generator: false
  version:
    provider: mike

# Extensions
markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - toc:
      permalink: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
      emoji_index: !!python/name:material.extensions.emoji.twemoji
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink:
      normalize_issue_symbols: true
      repo_url_shorthand: true
      user: squidfunk
      repo: mkdocs-material
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.snippets:
      auto_append:
        - includes/mkdocs.md
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
      combine_header_slug: true
      slugify: !!python/object/apply:pymdownx.slugs.slugify
        kwds:
          case: lower
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

# Page tree
nav:
  - Home: index.md
  - Getting Started:
    - getting-started/index.md
    - Quick Start: getting-started/quick-start.md
    - Test Suites:
      - getting-started/suites/index.md
    - Telemetry:
      - getting-started/telemetry/index.md

  - Guides:
    - guides/index.md
    - Optimization: guides/optimization.md
    - Troubleshooting: guides/troubleshooting.md
    - Developer:
      - Overview: guides/developer/index.md
      - Writing Tests: guides/developer/writing-tests.md
      - Configuration:
        - Profile & Test Config: guides/developer/configuration.md
        - System Requirements: guides/developer/requirements.md
      - Framework API:
        - Fixtures Reference: guides/developer/fixtures.md
        - Results & Metrics: guides/developer/results-metrics.md
        - KPI Validation: guides/developer/kpi-validation.md
      - Features:
        - Asset Management: guides/developer/assets.md
        - Modular Telemetry: guides/developer/telemetry.md
      - Advanced:
        - Best Practices: guides/developer/advanced.md
        - Allure Report Customization: guides/developer/allure-reports.md
  - About:
    - about/index.md
    - License: about/license.md
    - Support: about/support.md
    - Changelog: about/changelog.md