a2a-registry/mkdocs.yml at master · sigent-ai-dev/a2a-registry · 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
# Project information
site_name: A2A Registry
site_url: https://allenday.github.io/a2a-registry/
site_description: >-
  A comprehensive Agent-to-Agent (A2A) Registry server for seamless agent discovery, registration, and management.
site_dir: site

# Repository
repo_name: allenday/a2a-registry
repo_url: https://github.com/allenday/a2a-registry

# Copyright
copyright: Copyright &copy; 2025 Allen Day

# Navigation
nav:
  - Home: index.md
  - Documentation:
    - Overview: documentation/index.md
    - Getting Started:
      - Overview: documentation/getting-started/index.md
      - Installation: documentation/getting-started/installation.md
      - Quick Start: documentation/getting-started/quickstart.md
      - Configuration: documentation/getting-started/configuration.md
    - Concepts:
      - Agent Discovery: documentation/concepts/agent-discovery.md
      - Registry Architecture: documentation/concepts/architecture.md
      - Protocol Support: documentation/concepts/protocols.md
    - API Reference:
      - Overview: documentation/api/overview.md
      - Endpoints: documentation/api/endpoints.md
      - Client Libraries: documentation/api/clients.md
      - Examples: documentation/api/examples.md
      - API Documentation: documentation/api/reference.md
    - Developer Guide:
      - Contributing: documentation/developer/contributing.md
      - Development Setup: documentation/developer/setup.md
      - Testing Strategy: documentation/developer/testing.md
      - Release Process: documentation/developer/releases.md
      - Debugging: documentation/developer/debugging.md
    - Examples:
      - Basic Usage: documentation/examples/basic-usage.md
      - Agent Registration: documentation/examples/agent-registration.md
      - Agent Discovery: documentation/examples/agent-discovery.md
      - Advanced Scenarios: documentation/examples/advanced.md
    - Troubleshooting:
      - Common Issues: documentation/troubleshooting/common-issues.md
      - Performance Tuning: documentation/troubleshooting/performance.md
      - Logging and Monitoring: documentation/troubleshooting/logging.md

# Configuration
theme:
  name: material
  language: en
  font:
    text: Roboto
    code: Roboto Mono
  icon:
    repo: fontawesome/brands/github
    admonition:
      note: fontawesome/solid/note-sticky
      abstract: fontawesome/solid/book
      info: fontawesome/solid/circle-info
      tip: fontawesome/solid/bullhorn
      success: fontawesome/solid/check
      question: fontawesome/solid/circle-question
      warning: fontawesome/solid/triangle-exclamation
      failure: fontawesome/solid/bomb
      danger: fontawesome/solid/skull
      bug: fontawesome/solid/robot
      example: fontawesome/solid/flask
      quote: fontawesome/solid/quote-left
  palette:
    - scheme: default
      primary: blue
      accent: blue
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: blue
      accent: blue
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - announce.dismiss
    - content.code.annotate
    - content.code.copy
    - content.code.select
    - content.tabs.link
    - navigation.expand
    - navigation.footer
    - navigation.indexes
    - navigation.instant
    - navigation.instant.progress
    - navigation.path
    - navigation.tabs
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow

# Extensions
markdown_extensions:
  - footnotes
  - admonition
  - attr_list
  - md_in_html
  - tables
  - def_list
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets:
      url_download: true
      dedent_subsections: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
      slugify: !!python/object/apply:pymdownx.slugs.slugify
        kwds:
          case: lower
  - pymdownx.tasklist:
      custom_checkbox: true
  - toc:
      permalink: true

# Plugins
plugins:
  - search
  - autorefs
  - mkdocstrings:
      handlers:
        python:
          options:
            show_root_heading: false
            show_object_full_path: false
            show_if_no_docstring: true
            filters: ["!^_"]
            docstring_style: google
            docstring_options:
              ignore_init_summary: true
            merge_init_into_class: true
            show_submodules: true