agents-aea/mkdocs.yml at master · mandyohhh/agents-aea · 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
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
site_name: AEA Developer Documentation
site_url: https://docs.fetch.ai/
site_description: Everything you need to know about Fetch.AI.
#repo_url: https://github.com/fetchai/docs // commented out to remove edit option
#repo_name: 'GitHub'
site_author: diarmid.campbell@fetch.ai

theme:
  name: 'material'
  logo:
    icon: code
  feature:
    tabs: true

strict: true

nav:
  - AEA Framework:
    - Welcome: 'index.md'
    - Version: 'version.md'
    - Concepts:
      - Language Agnostic Definition: 'language-agnostic-definition.md'
      - Agent-oriented development: 'agent-oriented-development.md'
      - Vision: 'vision.md'
      - Application areas: 'app-areas.md'
      - Relation to OEF and Ledger: 'oef-ledger.md'
      - Identity: 'identity.md'
      # - Trust issues: 'trust.md'
    - Demos:
      - Demos: 'demos.md'
      - Aries Cloud Agents Demo: 'aries-cloud-agent-demo.md'
      - Car park skills: 'car-park-skills.md'
      - Gym example: 'gym-example.md'
      - Gym skill: 'gym-skill.md'
      - ML skills: 'ml-skills.md'
      - TAC skills: 'tac-skills.md'
      - TAC skills ledger-based: 'tac-skills-contract.md'
      - TAC external app: 'tac.md'
      - Thermometer skills: 'thermometer-skills.md'
      - Weather skills: 'weather-skills.md'
    - Development:
      - Getting started:
        - AEA quick start: 'quickstart.md'
        - Core components - Part 1: 'core-components-1.md'
        - AEA and web frameworks: 'aea-vs-mvc.md'
        - Build a skill for an AEA: 'skill-guide.md'
        - Core components - Part 2: 'core-components-2.md'
        - Trade between two AEAs: 'generic-skills-step-by-step.md'
      - Topic guides:
        - Ways to build an AEA: 'step-one.md'
        - Build an AEA with the CLI: 'build-aea-step-by-step.md'
        - Scaffolding packages: 'scaffolding.md'
        - Generating protocols: 'protocol-generator.md'
        - Logging: 'logging.md'
        - Use multiplexer stand-alone: 'multiplexer-standalone.md'
        - Create stand-alone transaction: 'standalone-transaction.md'
        - Create decision-maker transaction: 'decision-maker-transaction.md'
        - Testing Skills: 'skill-testing.md'
        - Deployment: 'deployment.md'
        - Known limitations: 'known-limits.md'
        - Build an AEA programmatically: 'build-aea-programmatically.md'
        - CLI vs programmatic AEAs: 'cli-vs-programmatic-aeas.md'
        - AEAs vs agents: 'agent-vs-aea.md'
        - Upgrading versions: 'upgrading.md'
        - Modes of running an AEA: 'modes.md'
        - Multi agent manager: 'multi-agent-manager.md'
        - Debugging: 'debug.md'
      - Use case components:
        - Generic skills: 'generic-skills.md'
        - Front-end intergration: 'connect-a-frontend.md'
        - HTTP Connection: 'http-connection-and-skill.md'
        - ORM integration: 'orm-integration.md'
        - Contract deploy and interact: 'erc1155-skills.md'
        - P2P Connection: 'p2p-connection.md'
        - Build an AEA on a Raspberry Pi: 'raspberry-set-up.md'
      - Architecture & component deep-dives:
        - Design principles: 'design-principles.md'
        - Architectural diagram: 'diagram.md'
        - Connections: 'connection.md'
        - Protocols: 'protocol.md'
        - Skills: 'skill.md'
        - Contracts: 'contract.md'
        - Decision Maker: 'decision-maker.md'
        - Ledger & Crypto APIs: 'ledger-integration.md'
        - Message routing: 'message-routing.md'
        - Configurations: 'config.md'
      - Agent Communication:
        - Agent Communication Network: 'acn.md'
      - Search & Discovery:
        - Simple OEF: 'simple-oef.md'
        - Defining Data Models: 'defining-data-models.md'
        - The Query Language: 'query-language.md'
        - SOEF Connection: 'simple-oef-usage.md'
      - Developer Interfaces:
        - CLI:
          - Installation: 'cli-how-to.md'
          - Commands: 'cli-commands.md'
          - File structure: 'package-imports.md'
          - Generating wealth: 'wealth.md'
        - GUI: 'cli-gui.md'
      - Benchmarks:
        - Performance benchmark: 'performance-benchmark.md'
      - API:
        - AbstractAgent: 'api/abstract_agent.md'
        - AEA: 'api/aea.md'
        - AEA Builder: 'api/aea_builder.md'
        - Agent: 'api/agent.md'
        - Agent Loop: 'api/agent_loop.md'
        - Common: 'api/common.md'
        - Exceptions: 'api/exceptions.md'
        - Launcher: 'api/launcher.md'
        - Manager: 'api/manager.md'
        - Multiplexer: 'api/multiplexer.md'
        - Runner: 'api/runner.md'
        - Runtime: 'api/runtime.md'
        - Components:
          - Base: 'api/components/base.md'
          - Loader: 'api/components/loader.md'
        - Configurations:
          - Base: 'api/configurations/base.md'
          - Constants: 'api/configurations/constants.md'
          - Loader: 'api/configurations/loader.md'
          - Project: 'api/configurations/project.md'
          - Pypi: 'api/configurations/pypi.md'
        - Connections:
          - Base: 'api/connections/base.md'
          - Stub Connection: 'api/connections/stub/connection.md'
        - Context: 'api/context/base.md'
        - Contracts:
          - Base: 'api/contracts/base.md'
        - Crypto:
          - Base: 'api/crypto/base.md'
          - Cosmos: 'api/crypto/cosmos.md'
          - Ethereum: 'api/crypto/ethereum.md'
          - Fetchai: 'api/crypto/fetchai.md'
          - Helpers: 'api/crypto/helpers.md'
          - LedgerApis: 'api/crypto/ledger_apis.md'
          - Wallet: 'api/crypto/wallet.md'
          - Registries:
            - Base: 'api/crypto/registries/base.md'
        - Decision Maker:
          - Base: 'api/decision_maker/base.md'
          - Default: 'api/decision_maker/default.md'
        - Helpers:
          - Async Friendly Queue: 'api/helpers/async_friendly_queue.md'
          - Async Utils: 'api/helpers/async_utils.md'
          - Base: 'api/helpers/base.md'
          - Dialogue:
            - Base: 'api/helpers/dialogue/base.md'
          - Exception Policy: 'api/helpers/exception_policy.md'
          - Exec Timeout: 'api/helpers/exec_timeout.md'
          - File Lock: 'api/helpers/file_lock.md'
          - IPFS:
            - Base: 'api/helpers/ipfs/base.md'
          - Logging: 'api/helpers/logging.md'
          - MultiAddress:
            - Base: 'api/helpers/multiaddr/base.md'
          - MultipleExecutor: 'api/helpers/multiple_executor.md'
          - Pipe: 'api/helpers/pipe.md'
          - Preferences:
            - Base: 'api/helpers/preference_representations/base.md'
          - Search:
            - Generic: 'api/helpers/search/generic.md'
            - Models: 'api/helpers/search/models.md'
          - Transaction:
            - Base: 'api/helpers/transaction/base.md'
          - Win32: 'api/helpers/win32.md'
          - YamlUtils: 'api/helpers/yaml_utils.md'
        - Identity: 'api/identity/base.md'
        - Mail: 'api/mail/base.md'
        - Protocols:
          - Base: 'api/protocols/base.md'
          - Generator:
            - Base: 'api/protocols/generator/base.md'
            - Common: 'api/protocols/generator/common.md'
            - Extract Specification: 'api/protocols/generator/extract_specification.md'
            - Validate: 'api/protocols/generator/validate.md'
          - Default Protocol:
            - Custom Types: 'api/protocols/default/custom_types.md'
            - Dialogues: 'api/protocols/default/dialogues.md'
            - Message: 'api/protocols/default/message.md'
            - Serialization: 'api/protocols/default/serialization.md'
          - Signing Protocol:
            - Custom Types: 'api/protocols/signing/custom_types.md'
            - Dialogues: 'api/protocols/signing/dialogues.md'
            - Message: 'api/protocols/signing/message.md'
            - Serialization: 'api/protocols/signing/serialization.md'
          - State Update Protocol:
            - Dialogues: 'api/protocols/state_update/dialogues.md'
            - Message: 'api/protocols/state_update/message.md'
            - Serialization: 'api/protocols/state_update/serialization.md'
        - Registries:
          - Base: 'api/registries/base.md'
          - Filter: 'api/registries/filter.md'
          - Resources: 'api/registries/resources.md'
        - Skills:
          - Base: 'api/skills/base.md'
          - Error Skill: 'api/skills/error/handlers.md'
          - Behaviors: 'api/skills/behaviours.md'
          - Task: 'api/skills/tasks.md'
        - Test Tools:
          - Generic: 'api/test_tools/generic.md'
          - Test Cases: 'api/test_tools/test_cases.md'
          - Test Skill: 'api/test_tools/test_skill.md'
    - Glossary: 'glossary.md'
    - Q&A: 'questions-and-answers.md'

plugins:
    - markdownmermaid

markdown_extensions:
  - pymdownx.superfences
  - admonition

extra_css:
    - css/my-styles.css

extra_javascript:
    - https://unpkg.com/mermaid@7.1.2/dist/mermaid.min.js