-
Notifications
You must be signed in to change notification settings - Fork 61
/
mkdocs.yml
353 lines (346 loc) · 14.1 KB
/
mkdocs.yml
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
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
site_name: AEA Framework Documentation
site_url: https://docs.fetch.ai/aea
site_description: Everything you need to know about the Autonomous Economic Agents.
repo_url: https://github.com/fetchai/agents-aea
repo_name: fetchai/agents-aea
edit_uri: ""
site_author: developer@fetch.ai
copyright: Copyright © 2018 - 2023 Fetch.ai # Copyright notice in footer
strict: true
nav:
- AEA Overview:
- Overview: 'index.md'
- Autonomous Economic Agents: 'aeas.md'
- Application areas: 'application.md'
- Agent ecosystem: 'ecosystem.md'
- Installation and setup:
- Installation: 'install.md'
- Setting up: 'setup.md'
- Development setup: 'development-setup.md'
- Upgrading: 'upgrading.md'
- Build an AEA on a Raspberry Pi: 'raspberry-set-up.md'
- Getting started:
- Core components: 'core-components.md'
- Ways to build an AEA: 'step-one.md'
- Build an AEA with the CLI: 'build-aea-step-by-step.md'
- Architecture deep dives:
- Language Agnostic Definition: 'language-agnostic-definition.md'
- Architectural diagram: 'diagram.md'
- Core components - Part 1: 'core-components-1.md'
- Core components - Part 2: 'core-components-2.md'
- Comparisons:
- AEA and web frameworks: 'aea-vs-mvc.md'
- 12-Factor app and AEAs: '12-factor.md'
- Design principles: 'design-principles.md'
- Developing Agents:
- Modes of running an AEA: 'modes.md'
- Multi agent manager: 'multi-agent-manager.md'
- Logging: 'logging.md'
- Deployment: 'deployment.md'
- Debugging: 'debug.md'
- Profiling: 'runtime-cost.md'
- Performance benchmark: 'performance-benchmark.md'
- Security Considerations: 'security.md'
- Developing Packages:
- File structure: 'package-imports.md'
- Scaffolding packages: 'scaffolding.md'
- Configurations: 'config.md'
- Skills:
- Skills: 'skill.md'
- AEA quick start: 'quickstart.md'
- Build your first skill - search & discovery: 'skill-guide.md'
- Trade between two AEAs: 'generic-skills-step-by-step.md'
- Testing Skills: 'skill-testing.md'
- Protocols:
- Protocols: 'protocol.md'
- Message routing: 'message-routing.md'
- Generating protocols: 'protocol-generator.md'
- Connections:
- Connections: 'connection.md'
- Contracts:
- Contracts: 'contract.md'
- Contract deploy and interact: 'erc1155-skills.md'
- Decision Maker:
- Decision Maker: 'decision-maker.md'
- Ledger & Crypto APIs:
- Ledger & Crypto APIs: 'ledger-integration.md'
- Ecosystem:
- Agent Communication:
- Agent Communication Network: 'acn.md'
- ACN Internals: 'acn-internals.md'
- Proof of Representation: 'por.md'
- P2P Connection: 'p2p-connection.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'
- Integrations:
- Front-end integration: 'connect-a-frontend.md'
- ORM integration: 'orm-integration.md'
- Generic Storage: 'generic-storage.md'
- Prometheus monitoring: 'prometheus.md'
- Generating wealth: 'wealth.md'
- Guides:
- Agent-oriented development: 'agent-oriented-development.md'
- Interaction protocols: 'interaction-protocol.md'
- Concepts:
- Identity: 'identity.md'
- Trust minimisation: 'trust.md'
- Development - Advanced:
- Build an AEA programmatically: 'build-aea-programmatically.md'
- CLI vs programmatic AEAs: 'cli-vs-programmatic-aeas.md'
- AEAs vs agents: 'agent-vs-aea.md'
- Use multiplexer stand-alone: 'multiplexer-standalone.md'
- Create stand-alone transaction: 'standalone-transaction.md'
- Create decision-maker transaction: 'decision-maker-transaction.md'
- Demos:
- Demos: 'demos.md'
- Generic skills: 'generic-skills.md'
- HTTP Connection: 'http-connection-and-skill.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'
- Oracle skills: 'oracle-demo.md'
- Aggregation skill: 'aggregation-demo.md'
- TAC skills: 'tac-skills.md'
- TAC skills ledger-based: 'tac-skills-contract.md'
- Thermometer skills: 'thermometer-skills.md'
- Weather skills: 'weather-skills.md'
- Reference:
- Command Line Interface: 'cli-commands.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'
- Multiplexer: 'api/multiplexer.md'
- Runner: 'api/runner.md'
- Runtime: 'api/runtime.md'
- Components:
- Base: 'api/components/base.md'
- Loader: 'api/components/loader.md'
- Utils: 'api/components/utils.md'
- Configurations:
- Base: 'api/configurations/base.md'
- Constants: 'api/configurations/constants.md'
- Data Types: 'api/configurations/data_types.md'
- Loader: 'api/configurations/loader.md'
- Manager: 'api/configurations/manager.md'
- Pypi: 'api/configurations/pypi.md'
- Utils: 'api/configurations/utils.md'
- Validation: 'api/configurations/validation.md'
- Connections:
- Base: 'api/connections/base.md'
- Context: 'api/context/base.md'
- Contracts:
- Base: 'api/contracts/base.md'
- Crypto:
- Base: 'api/crypto/base.md'
- Helpers: 'api/crypto/helpers.md'
- LedgerApis: 'api/crypto/ledger_apis.md'
- Plugin: 'api/crypto/plugin.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'
- GOP: 'api/decision_maker/gop.md'
- Error Handler:
- Base: 'api/error_handler/base.md'
- Default: 'api/error_handler/default.md'
- Helpers:
- ACN:
- Agent Record: 'api/helpers/acn/agent_record.md'
- URI: 'api/helpers/acn/uri.md'
- Async Friendly Queue: 'api/helpers/async_friendly_queue.md'
- Async Utils: 'api/helpers/async_utils.md'
- Base: 'api/helpers/base.md'
- Constants: 'api/helpers/constants.md'
- Env Vars: 'api/helpers/env_vars.md'
- Exception Policy: 'api/helpers/exception_policy.md'
- Exec Timeout: 'api/helpers/exec_timeout.md'
- File IO: 'api/helpers/file_io.md'
- File Lock: 'api/helpers/file_lock.md'
- HttpRequests: 'api/helpers/http_requests.md'
- Install Dependency: 'api/helpers/install_dependency.md'
- IO: 'api/helpers/io.md'
- IPFS:
- Base: 'api/helpers/ipfs/base.md'
- Utils: 'api/helpers/ipfs/utils.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'
- Profiling: 'api/helpers/profiling.md'
- Search:
- Generic: 'api/helpers/search/generic.md'
- Models: 'api/helpers/search/models.md'
- Serializers: 'api/helpers/serializers.md'
- Storage:
- GenericStorage: 'api/helpers/storage/generic_storage.md'
- Backends:
- Base: 'api/helpers/storage/backends/base.md'
- Sqlite: 'api/helpers/storage/backends/sqlite.md'
- Sym Link: 'api/helpers/sym_link.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'
- Manager:
- Manager: 'api/manager/manager.md'
- Project: 'api/manager/project.md'
- Utils: 'api/manager/utils.md'
- Protocols:
- Base: 'api/protocols/base.md'
- Dialogue:
- Base: 'api/protocols/dialogue/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'
- Behaviors: 'api/skills/behaviours.md'
- Task: 'api/skills/tasks.md'
- Test Tools:
- Constants: 'api/test_tools/constants.md'
- Exceptions: 'api/test_tools/exceptions.md'
- Generic: 'api/test_tools/generic.md'
- Test Cases: 'api/test_tools/test_cases.md'
- Test Contract: 'api/test_tools/test_contract.md'
- Test Skill: 'api/test_tools/test_skill.md'
- Plugins:
- CLI:
- IPFS:
- API: 'api/plugins/aea_cli_ipfs/core.md'
- Utils: 'api/plugins/aea_cli_ipfs/ipfs_utils.md'
- Ledger:
- Cosmos:
- API: 'api/plugins/aea_ledger_cosmos/cosmos.md'
- Ethereum:
- API: 'api/plugins/aea_ledger_ethereum/ethereum.md'
- Fetchai:
- API: 'api/plugins/aea_ledger_fetchai/fetchai.md'
- Helper: 'api/plugins/aea_ledger_fetchai/_cosmos.md'
- Limitations of v1: 'limits.md'
- Known limitations: 'known-limits.md'
- Glossary: 'glossary.md'
- Q&A: 'questions-and-answers.md'
- Archives:
- TAC external app: 'tac.md'
theme:
name: material
language: en
palette: # Set light/dark theme button next to the search bar
- media: "(prefers-color-scheme: light)"
scheme: default
toggle:
icon: material/weather-night
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
toggle:
icon: material/weather-sunny
name: Switch to light mode
logo: assets/images/logo.png # Set Fetch Logo top left
favicon: assets/images/favicon.ico # Set Fetch favicon
icon:
repo: fontawesome/brands/github
features:
- navigation.instant # Fast page loading
- navigation.tracking # URL automatically updated with the currently active anchor
# - navigation.tabs
# - navigation.tabs.sticky
# - navigation.sections
# - navigation.expand
# - navigation.indexes
- navigation.top # Back-to-top button
- navigation.footer # Add links to the previous and next page of the current page
- search.suggest # Completion for the searched word (can be accepted with ->).
- search.highlight # Highlight all occurrences after following a search result link
- search.share # Show share button for copying deep link to the current search query and result
- toc.follow # Follow the table of content
- content.action.view # Shows button to "view the source of this page"
- content.code.copy # Shows a button next to code blocks to copy the code into clipboard
# custom_dir: docs/overrides # Uncomment to enable announcements bar at the top
extra_css:
- css/my-styles.css
- css/admonitions.css
markdown_extensions:
- admonition # Required by admonitions
- pymdownx.superfences: # Required by admonitions, annotations, tabs. Enables arbitrary nesting of code and content blocks
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.highlight: # Required by code blocks
anchor_linenums: true
- pymdownx.inlinehilite # Required by code blocks
- pymdownx.snippets # Required by code blocks
- pymdownx.superfences # Required by admonitions, code blocks
- pymdownx.details # Required by admonitions, code blocks
- attr_list # Required by annotations
- md_in_html # Required by annotations
- pymdownx.tabbed: # Required by tabs
alternate_style: true
- tables # # Required by tables
- toc:
permalink: true
- def_list
plugins:
- search # Enables search
extra:
social:
- icon: fontawesome/brands/twitter
link: https://bit.ly/3oDuI3f
name: fetch.ai on twitter
- icon: fontawesome/brands/telegram
link: https://t.me/fetch_ai
name: fetch.ai on telegram
- icon: fontawesome/brands/discord
link: https://bit.ly/3ra5uMI
name: fetch.ai on discord
- icon: fontawesome/brands/github
link: https://bit.ly/3AFCWxl
name: fetch.ai on github
- icon: fontawesome/brands/reddit
link: https://bit.ly/30zS1Tg
name: fetch.ai on reddit
- icon: fontawesome/brands/youtube
link: https://bit.ly/3DxFazs
name: fetch.ai on youtube
- icon: fontawesome/brands/linkedin
link: https://bit.ly/3kNO70p
name: fetch.ai on linkedin