documentation/mkdocs.yml at main · telemetryforge/documentation · 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
site_name: Telemetry Forge Agent Documentation
site_url: https://telemetryforge.io
nav:
  - Home: index.md
  - Features:
    - Overview: features/index.md
    - Record Deduplication: features/record-deduplication.md
    - Log Sampling: features/log-sampling.md
    - Git Configuration Auto-Reload: features/git-config-auto-reload.md
    - Hardening and Optimisation: build-optimisations.md
  - Security:
    - Overview: security.md
    - CVE Information: security/cves.md
    - Current Triaged Vulnerabilities: security/triaged.md
  - Supported Platforms: supported-platforms.md
  - Version Mapping: version-mapping.md
plugins:
  - privacy
  - offline
  - search
  - social
  - meta
markdown_extensions:
  - pymdownx.snippets

theme:
  name: material
  highlightjs: true
  copyright: Telemetry Forge 2026
  custom_dir: overrides

  palette:
    # Dark Mode
    - scheme: slate
      toggle:
        icon: material/weather-sunny
        name: Dark mode
      primary: yellow
      accent: deep purple

    # Light Mode
    - scheme: default
      toggle:
        icon: material/weather-night
        name: Light mode
      primary: yellow
      accent: deep orange
  features:
    - header.autohide
    - announce.dismiss
    - navigation.footer
extra:
  homepage: https://telemetryforge.io
  # Disable made by mkdocs
  generator: false
  consent:
    title: Cookie consent
    description: >-
      We use cookies to recognize your repeated visits and preferences, as well
      as to measure the effectiveness of our documentation and whether users
      find what they're searching for. With your consent, you're helping us to
      make our documentation better.
    actions:
      - accept
      - manage
      - reject
    cookies:
      analytics:
        name: Google Analytics
        checked: false
      github:
        name: Github
        checked: false
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/telemetryforge
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/company/telemetry-forge
    - icon: fontawesome/solid/paper-plane
      link: mailto:info@telemetryforge.io
copyright: >
  Copyright &copy; 2025 - 2026 Telemetry Forge
  <a href="#__consent">Change cookie settings</a>