agenttel-sdk/mkdocs.yml at main · AgentTel/agenttel-sdk · 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
site_name: AgentTel
site_description: Agent-Ready Telemetry for OpenTelemetry
site_url: https://agenttel.dev
repo_url: https://github.com/agenttel/agenttel-sdk
repo_name: agenttel/agenttel-sdk

theme:
  name: material
  custom_dir: docs/overrides
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: deep purple
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: deep purple
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  font:
    text: Inter
    code: JetBrains Mono
  features:
    - navigation.sections
    - navigation.top
    - navigation.indexes
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.tabs.link
    - toc.follow
    - navigation.tabs
  icon:
    repo: fontawesome/brands/github

nav:
  - Home: index.md
  - Getting Started:
    - Overview: getting-started/overview.md
    - Quick Start: getting-started/quick-start.md
    - FAQ: getting-started/faq.md
  - Concepts:
    - Architecture: concepts/architecture.md
    - Semantic Conventions: concepts/semantic-conventions.md
    - Design Philosophy: concepts/design-philosophy.md
  - Guides:
    - MCP Server & Agent Tools: guides/mcp-server.md
    - Incident Response: guides/incident-response.md
    - Agent Observability: guides/agent-observability.md
    - Orchestration Patterns: guides/orchestration-patterns.md
    - Agent Cost Tracking: guides/agent-cost-tracking.md
    - Guardrails & Safety: guides/guardrails-and-safety.md
    - Zero-Code Mode: guides/zero-code-mode.md
    - Anomaly Detection: guides/anomaly-detection.md
    - Frontend Telemetry: guides/frontend-telemetry.md
    - Instrumentation Agent: guides/instrumentation-agent.md
    - Multi-Agent Patterns: guides/multi-agent.md
    - Python FastAPI: guides/python-fastapi.md
    - Python GenAI: guides/python-genai.md
    - GenAI Instrumentation: guides/genai-instrumentation.md
  - Reference:
    - Attribute Dictionary: reference/attribute-dictionary.md
    - Agentic Attributes: reference/agent-attributes.md
    - Event Catalog: reference/event-catalog.md
    - Configuration: reference/configuration.md
    - MCP Tools: reference/mcp-tools.md
    - API Reference: reference/api-reference.md
    - Python API: reference/python-api.md
    - Javadoc: reference/javadoc.md
  - Project:
    - Roadmap: project/roadmap.md
    - Contributing: project/contributing.md
    - Security: project/security.md

validation:
  links:
    absolute_links: ignore
    unrecognized_links: ignore

plugins:
  - search

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

extra_css:
  - stylesheets/extra.css

extra_javascript:
  - javascripts/mermaid-fix.js

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/agenttel/agenttel-sdk