-
Notifications
You must be signed in to change notification settings - Fork 10
/
mkdocs.yml
253 lines (245 loc) · 8.41 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
site_name: Protean
site_url: https://docs.proteanhq.com
repo_name: proteanhq/protean
repo_url: https://github.com/proteanhq/protean
copyright: Copyright © 2019 - 2024 Subhash Bhushan
theme:
name: material
custom_dir: docs/overrides
logo: assets/logo.png
favicon: assets/favicon.png
language: custom
font:
text: Inter
code: JetBrains Mono
palette:
- media: '(prefers-color-scheme: light)'
scheme: default
toggle:
icon: material/lightbulb
name: Switch to dark mode
- media: '(prefers-color-scheme: dark)'
scheme: slate
toggle:
icon: material/lightbulb-outline
name: Switch to light mode
features:
- content.code.annotate
- content.code.copy
- content.code.select
- content.tabs.link
- content.tooltips
- navigation.expand
- navigation.footer
- navigation.indexes
- navigation.instant
- navigation.instant.prefetch
- navigation.instant.progress
- navigation.path
- navigation.prune
- navigation.sections
- navigation.tabs
- navigation.tabs.sticky
- navigation.top
- navigation.tracking
- search.highlight
- search.suggest
- toc.follow
extra_css:
- stylesheets/extra.css
plugins:
- privacy
markdown_extensions:
- admonition
- attr_list
- tables
- md_in_html
- mdx_include
- pymdownx.details
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.snippets:
check_paths: true
base_path: docs_src
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
nav:
- Protean:
- index.md
- start-here.md
- features.md
- core-concepts/philosophy.md
- Core Concepts:
- core-concepts/analysis-model.md
- core-concepts/streams.md
- core-concepts/identity.md
- core-concepts/changing-state.md
- Architecture Patterns:
- core-concepts/ddd.md
- core-concepts/cqrs.md
- core-concepts/event-sourcing.md
# - Domain-Driven Design:
# - core-concepts/domain-driven-design/index.md
# - core-concepts/domain-driven-design/ubiquitous-language.md
# - core-concepts/domain-driven-design/bounded-contexts.md
# - core-concepts/domain-driven-design/contexts-and-subdomains.md
# - core-concepts/domain-driven-design/strategic-design.md
# - core-concepts/domain-driven-design/tactical-design.md
- Building Blocks:
- core-concepts/building-blocks/index.md
- core-concepts/building-blocks/aggregates.md
- core-concepts/building-blocks/entities.md
- core-concepts/building-blocks/value-objects.md
- core-concepts/building-blocks/domain-services.md
- core-concepts/building-blocks/events.md
- core-concepts/building-blocks/commands.md
- core-concepts/building-blocks/command-handlers.md
# - core-concepts/building-blocks/event-handlers.md
# - core-concepts/building-blocks/repositories.md
# - core-concepts/building-blocks/models.md
# - core-concepts/building-blocks/view-models.md
# - Command-Query Responsibility Segregation:
# - core-concepts/command-query-responsibility-segregation/index.md
# - core-concepts/command-query-responsibility-segregation/commands.md
# - core-concepts/command-query-responsibility-segregation/queries.md
# - core-concepts/command-query-responsibility-segregation/events.md
# - Event Sourcing:
# - core-concepts/event-sourcing/index.md
# - core-concepts/event-sourcing/events.md
# - core-concepts/event-sourcing/snapshots.md
# - core-concepts/event-sourcing/projections.md
- Guides:
- guides/getting-started/installation.md
# - guides/getting-started/quickstart.md
- Domain Model:
- Compose a Domain:
- guides/compose-a-domain/register-elements.md
- guides/compose-a-domain/initialize-domain.md
- guides/compose-a-domain/activate-domain.md
- guides/compose-a-domain/when-to-compose.md
- guides/compose-a-domain/element-decorators.md
- Defining Concepts:
- guides/domain-definition/index.md
- Fields:
- guides/domain-definition/fields/index.md
- guides/domain-definition/fields/arguments.md
- guides/domain-definition/fields/simple-fields.md
- guides/domain-definition/fields/container-fields.md
- guides/domain-definition/fields/association-fields.md
- guides/domain-definition/aggregates.md
- guides/domain-definition/entities.md
- guides/domain-definition/value-objects.md
- guides/domain-definition/events.md
- Adding Behavior:
- guides/domain-behavior/index.md
- guides/domain-behavior/validations.md
- guides/domain-behavior/invariants.md
- guides/domain-behavior/aggregate-mutation.md
- guides/domain-behavior/raising-events.md
- guides/domain-behavior/domain-services.md
- Foundation:
- guides/object-model.md
- guides/identity.md
- guides/configuration.md
- App Layer:
- Changing State:
- guides/change-state/index.md
- guides/change-state/application-services.md
- guides/change-state/commands.md
- guides/change-state/command-handlers.md
- Persisting State:
- guides/change-state/persist-aggregates.md
- guides/change-state/unit-of-work.md
- guides/change-state/retrieve-aggregates.md
- Consuming State Changes:
- guides/consume-state/index.md
- guides/consume-state/event-handlers.md
- guides/consume-state/views.md
# - guides/consume-state/events-across-contexts.md
# - Application Layer:
# - guides/app-layer/index.md
# - guides/app-layer/application-services.md
# - guides/domain-definition/subscribers.md
# - Infrastructure:
# - guides/app-layer/index.md (ports-and-adapters)
# - guides/app-layer/persisting-data.md (unit-of-work)
# - guides/app-layer/views.md
# - guides/app-layer/providers.md
# - guides/app-layer/models.md
# - guides/app-layer/brokers.md
# - guides/app-layer/caches.md
# - guides/app-layer/event-stores.md
# - Adapters (Port Definition):
# - guides/adapters/index.md
# - guides/adapters/database.md
# - guides/adapters/message-brokers.md
# - guides/adapters/caches.md
# - guides/adapters/event-stores.md
# - CQRS:
# - guides/command-handling/index.md (flow)
# - guides/command-handling/commands.md
# - guides/command-handling/command-handlers.md
# - guides/event-handling/event-handlers.md
# - Event Sourcing:
# - guides/event-sourcing/index.md
# - guides/event-sourcing/event-sourced-aggregates.md
# - guides/event-sourcing/snapshots.md
# - guides/event-sourcing/projections.md
# - guides/event-sourcing/flow.md
# - Testing:
# - guides/testing/index.md (100% testability)
# - guides/testing/unit-testing.md
# - guides/testing/integration-testing.md
# - guides/testing/functional-testing.md
# - guides/testing/acceptance-testing.md
- Utilities:
- CLI:
- guides/cli/index.md
- guides/cli/discovery.md
- guides/cli/new.md
- guides/cli/shell.md
- guides/cli/docs.md
- guides/cli/test.md
# - Advanced:
# - advanced/index.md
# - advanced/multi-domain.md
# - advanced/escape-hatches.md
# - advanced/security.md
# - advanced/performance.md
# - advanced/monitoring.md
# - advanced/integration.md
# - advanced/troubleshooting.md
# - API:
# - api/index.md
# - Examples:
# - examples/index.md
# - examples/quickstart.md
# - faq.md
- Adapters:
- adapters/index.md
- adapters/internals.md
- Database:
- adapters/database/index.md
- adapters/database/postgresql.md
- adapters/database/elasticsearch.md
- Brokers:
- adapters/broker/index.md
- adapters/broker/redis.md
- Caches:
- adapters/cache/index.md
- adapters/cache/redis.md
- Event Stores:
- adapters/eventstore/index.md
- adapters/eventstore/message-db.md
- Patterns:
- patterns/index.md
- glossary.md
# - changelog.md
- Community:
- community/index.md
- community/contributing/setup.md
- community/contributing/adapters.md