openagents/mkdocs.yml at develop · Mitchellhk/openagents · 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
# Project information
site_name: OpenAgents
site_description: An Open Framework for Connecting AI Agents at Scale
site_author: OpenAgents
site_url: https://openagents.org

# Repository
repo_name: bestagents/openagents
repo_url: https://github.com/bestagents/openagents
edit_uri: edit/main/docs/

# Copyright
copyright: Copyright &copy; 2023 OpenAgents Team

# Configuration
theme:
  name: material
  palette:
    primary: indigo
    accent: indigo
  font:
    text: Roboto
    code: Roboto Mono
  icon:
    logo: material/robot
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.expand
    - navigation.indexes
    - navigation.top
    - search.highlight
    - search.share
    - content.code.annotate
  custom_dir: docs/overrides

# Extensions
markdown_extensions:
  - admonition
  - attr_list
  - codehilite:
      guess_lang: false
  - def_list
  - footnotes
  - meta
  - toc:
      permalink: true
  - pymdownx.arithmatex
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.critic
  - pymdownx.details
  - pymdownx.emoji:
      emoji_generator: !!python/name:pymdownx.emoji.to_svg
  - pymdownx.highlight
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

# Plugins
plugins:
  - search
  - autorefs:
      link_titles: true
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          options:
            docstring_style: google
            show_source: true
  - git-revision-date-localized:
      type: date

# Extra CSS
extra_css:
  - stylesheets/extra.css

# Extra
extra:
  404_page: 404.md
  homepage: https://openagents.org
  social:
    - icon: fontawesome/solid/globe
      link: https://openagents.org
      name: OpenAgents Website

# Navigation structure
nav:
  - Home: index.md
  - Getting Started:
    - Installation: getting-started/installation.md
    - Quick Start: getting-started/quick-start.md
    - Basic Concepts: getting-started/basic-concepts.md
  - User Guide:
    - Creating Agents: user-guide/creating-agents.md
    - Setting Up Networks: user-guide/setting-up-networks.md
    - Using Protocols: user-guide/using-protocols.md
    - Configuration Files: user-guide/configuration-files.md
    - Command Line Interface: user-guide/command-line-interface.md
  - Protocols:
    - Overview: protocols/overview.md
    - Discovery Protocol: protocols/discovery.md
    - Communication Protocol: protocols/communication.md
    - Heartbeat Protocol: protocols/heartbeat.md
    - Identity Protocol: protocols/identity.md
    - Coordination Protocol: protocols/coordination.md
    - Resource Management Protocol: protocols/resource-management.md
  - Advanced Topics:
    - Custom Protocols: advanced/custom-protocols.md
    - Agent Patterns: advanced/agent-patterns.md
    - Network Topologies: advanced/network-topologies.md
    - Security Considerations: advanced/security.md
    - Performance Optimization: advanced/performance.md
  - API Reference:
    - Core: api/core.md
    - Protocols: api/protocols.md
    - Models: api/models.md
    - CLI: api/cli.md
  - Development:
    - Contributing: development/contributing.md
    - Development Setup: development/setup.md
    - Testing: development/testing.md
    - Documentation: development/documentation.md
  - Examples:
    - Basic Network: examples/basic-network.md
    - Service Discovery: examples/service-discovery.md
    - Pub-Sub Messaging: examples/pub-sub-messaging.md
    - Request-Response: examples/request-response.md
  - FAQ: faq.md
  - Changelog: changelog.md