omniobserve/mkdocs.yml at main · plexusone/omniobserve · 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
site_name: OmniObserve
site_description: Unified Go library for observability - LLM tracing and app metrics/traces/logs
site_url: https://plexusone.github.io/omniobserve
repo_url: https://github.com/plexusone/omniobserve
repo_name: plexusone/omniobserve

theme:
  name: material
  custom_dir: docs/overrides
  palette:
    # Dark mode first (PlexusOne default)
    - scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
    - scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
  features:
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.highlight
    - content.code.copy

extra_css:
  - https://plexusone.dev/css/plexusone-mkdocs.css

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - admonition
  - pymdownx.details
  - tables
  - toc:
      permalink: true

nav:
  - Home: index.md
  - Getting Started:
      - Installation: getting-started/installation.md
      - Quick Start: getting-started/quickstart.md
      - Configuration: getting-started/configuration.md
  - LLM Providers:
      - Overview: providers/index.md
      - Opik: providers/opik.md
      - Langfuse: providers/langfuse.md
      - Phoenix: providers/phoenix.md
      - slog: providers/slog.md
  - App Observability (observops):
      - OTLP: providers/otlp.md
      - Datadog: providers/datadog.md
      - New Relic: providers/newrelic.md
      - Dynatrace: providers/dynatrace.md
      - sloghandler: providers/sloghandler.md
  - Features:
      - Tracing: features/tracing.md
      - Evaluation Metrics: features/metrics.md
      - Datasets: features/datasets.md
      - Prompts: features/prompts.md
  - Integrations:
      - OmniLLM: integrations/omnillm.md
      - Structured Evaluation: integrations/sevaluation.md
  - Architecture: architecture.md
  - Guides:
      - Stats Agent Observability: guides/integration-guide-stats-agent-team.md
  - API Reference: https://pkg.go.dev/github.com/plexusone/omniobserve
  - Releases:
      - Changelog: releases/changelog.md
      - v0.9.0: releases/v0.9.0.md
      - v0.8.0: releases/v0.8.0.md
      - v0.7.0: releases/v0.7.0.md
      - v0.6.0: releases/v0.6.0.md
      - v0.5.0: releases/v0.5.0.md

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/plexusone/omniobserve