-
Notifications
You must be signed in to change notification settings - Fork 65
/
Copy pathmkdocs.yml
257 lines (250 loc) · 9.99 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
site_name: aea
site_url: https://docs.fetch.ai/
site_description: Everything you need to know about AEAs.
repo_url: https://github.com/agents-aea/docs
site_author: developer@fetch.ai
theme:
name: 'material'
logo:
icon: code
feature:
tabs: true
strict: true
nav:
- Introduction: 'index.md'
- Version: 'version.md'
- Upgrading: 'upgrading.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 minimisation: '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'
- Oracle skills: 'oracle-demo.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 - Beginner:
- AEA quick start: 'quickstart.md'
- Core components - Part 1: 'core-components-1.md'
- AEA and web frameworks: 'aea-vs-mvc.md'
- Build your first skill - search & discovery: 'skill-guide.md'
- Core components - Part 2: 'core-components-2.md'
- How AEAs talk to each other - interaction protocols: 'interaction-protocol.md'
- Trade between two AEAs: 'generic-skills-step-by-step.md'
- Development setup: 'development-setup.md'
- Development - Advanced:
- 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'
- Prometheus monitoring: 'prometheus.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'
- Modes of running an AEA: 'modes.md'
- Generic Storage: 'generic-storage.md'
- Multi agent manager: 'multi-agent-manager.md'
- Debugging: 'debug.md'
- Profiling: 'runtime-cost.md'
- Proof of Representation: 'por.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'
- 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'
- 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'
- 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'
- 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'
- 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 Skill: 'api/test_tools/test_skill.md'
- Plugins:
- 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'
- Development - Use Case:
- 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'
- Glossary: 'glossary.md'
- Q&A: 'questions-and-answers.md'
plugins:
- markdownmermaid
markdown_extensions:
- pymdownx.superfences
- pymdownx.highlight
- admonition
extra_css:
- css/my-styles.css
extra_javascript:
- https://unpkg.com/mermaid@7.1.2/dist/mermaid.min.js