diff --git a/docs/docs/.vitepress/config.ts b/docs/docs/.vitepress/config.ts index 8c957347..5200d2dc 100644 --- a/docs/docs/.vitepress/config.ts +++ b/docs/docs/.vitepress/config.ts @@ -71,71 +71,80 @@ export default defineConfig({ text: 'Aggregates', collapsible: true, items: [ - { text: 'Introduction', link: '/guide/aggregates/' }, { - text: 'Creating an Aggregate', - link: '/guide/aggregates/#creating-an-aggregate', - }, - { text: 'Repositories', link: '/guide/aggregates/repositories' }, - { - text: 'Event Handling', - link: '/guide/aggregates/event-handling', - }, - { - text: 'Command Handling', - link: '/guide/aggregates/command-handling', + text: 'README', + link: '/guide/aggregates/readme.md', }, + // { + // text: 'Introduction', + // link: '/guide/aggregates/', + // }, + // { + // text: 'Creating an Aggregate', + // link: '/guide/aggregates/create', + // }, + // { text: 'Repositories', link: '/guide/aggregates/repositories' }, + // { + // text: 'Event Handling', + // link: '/guide/aggregates/event-handling', + // }, + // { + // text: 'Command Handling', + // link: '/guide/aggregates/command-handling', + // }, ], }, { text: 'Projections', collapsible: true, items: [ - { text: 'Introduction', link: '/guide/projections/' }, - { text: 'Scheduling', link: '/guide/projections/scheduling' }, - { text: 'Projection Jobs', link: '/guide/projections/jobs' }, - { text: 'Projection Service', link: '/guide/projections/service' }, - { - text: 'Best Practices', - link: '/guide/projections/best-practices', - }, + { text: 'README', link: '/guide/projections/readme' }, + // { text: 'Introduction', link: '/guide/projections/' }, + // { text: 'Scheduling', link: '/guide/projections/scheduling' }, + // { text: 'Projection Jobs', link: '/guide/projections/jobs' }, + // { text: 'Projection Service', link: '/guide/projections/service' }, + // { + // text: 'Best Practices', + // link: '/guide/projections/best-practices', + // }, ], }, { text: 'Commands', collapsible: true, items: [ - { text: 'Introduction', link: '/guide/commands/' }, - { - text: 'Defining Commands', - link: '/guide/commands/#defining-commands', - }, - { - text: 'Command Registry', - link: '/guide/command/command-registry', - }, - { text: 'Command Bus', link: '/guide/commands/command-bus' }, - { - text: 'Command Handling', - link: '/guide/commands/command-handling', - }, + { text: 'README', link: '/guide/commands/readme' }, + // { text: 'Introduction', link: '/guide/commands/' }, + // { + // text: 'Defining Commands', + // link: '/guide/commands/#defining-commands', + // }, + // { + // text: 'Command Registry', + // link: '/guide/command/command-registry', + // }, + // { text: 'Command Bus', link: '/guide/commands/command-bus' }, + // { + // text: 'Command Handling', + // link: '/guide/commands/command-handling', + // }, ], }, { text: 'Process Manages / SAGAs', collapsible: true, - items: [{ text: 'TODO', link: '/' }], + items: [{ text: 'README', link: '/guide/process-managers/readme' }], }, { text: 'Tools & Helpers', collapsible: true, collapsed: true, items: [ - { text: 'Aggregate Lookup', link: '/guide/tools/aggregate-lookup' }, - { - text: 'Streaming Helpers', - link: '/guide/tools/streaming-helpers', - }, + // { text: 'Aggregate Lookup', link: '/guide/tools/aggregate-lookup' }, + // { + // text: 'Streaming Helpers', + // link: '/guide/tools/streaming-helpers', + // }, ], }, { @@ -149,34 +158,40 @@ export default defineConfig({ collapsible: true, collapsed: true, items: [ - { text: 'Authorization', link: '/guide/modules/authorization' }, + // { text: 'Authorization', link: '/guide/modules/authorization' }, ], }, { - text: 'Backends – Event Bus', + text: 'Backends', collapsible: true, collapsed: true, items: [ - { text: 'In-Memory', link: '/guide/backends/event-bus/nats' }, - { text: 'NATS', link: '/guide/backends/event-bus/nats' }, - ], - }, - { - text: 'Backends – Event Store', - collapsible: true, - collapsed: true, - items: [ - { - text: 'In-Memory', - link: '/guide/backends/event-store/nats', - }, { - text: 'MongoDB', - link: '/guide/backends/event-store/mongodb', + text: 'Event Bus', + items: [ + { + text: 'In-Memory', + link: '/guide/backends/event-bus/in-memory', + }, + { text: 'NATS', link: '/guide/backends/event-bus/nats' }, + ], }, { - text: 'Postgres', - link: '/guide/backends/event-store/postgres', + text: 'Event Store', + items: [ + { + text: 'In-Memory', + link: '/guide/backends/event-store/in-memory', + }, + { + text: 'MongoDB', + link: '/guide/backends/event-store/mongodb', + }, + { + text: 'Postgres', + link: '/guide/backends/event-store/postgres', + }, + ], }, ], }, diff --git a/docs/docs/guide/aggregates/command-handling.md b/docs/docs/guide/aggregates/command-handling.md new file mode 100644 index 00000000..b8d5bd30 --- /dev/null +++ b/docs/docs/guide/aggregates/command-handling.md @@ -0,0 +1,3 @@ +# Command Handling + +_TBD_ diff --git a/docs/docs/guide/aggregates/create.md b/docs/docs/guide/aggregates/create.md new file mode 100644 index 00000000..87326dfa --- /dev/null +++ b/docs/docs/guide/aggregates/create.md @@ -0,0 +1,3 @@ +# Creating an Aggregate + +_TBD_ diff --git a/docs/docs/guide/aggregates/event-handling.md b/docs/docs/guide/aggregates/event-handling.md new file mode 100644 index 00000000..ecd7bbc4 --- /dev/null +++ b/docs/docs/guide/aggregates/event-handling.md @@ -0,0 +1,3 @@ +# Event Handling + +_TBD_ diff --git a/docs/docs/guide/aggregates/index.md b/docs/docs/guide/aggregates/index.md new file mode 100644 index 00000000..6d312e67 --- /dev/null +++ b/docs/docs/guide/aggregates/index.md @@ -0,0 +1,3 @@ +# Aggregates + +_TBD_ diff --git a/docs/docs/guide/aggregates/readme.md b/docs/docs/guide/aggregates/readme.md new file mode 100644 index 00000000..0e9fa7a0 --- /dev/null +++ b/docs/docs/guide/aggregates/readme.md @@ -0,0 +1,8 @@ +::: info +Documentation for aggregates has not been written yet but you can read the +README of the `aggregate` package below. +::: + +
+ + diff --git a/docs/docs/guide/aggregates/repositories.md b/docs/docs/guide/aggregates/repositories.md new file mode 100644 index 00000000..6626762c --- /dev/null +++ b/docs/docs/guide/aggregates/repositories.md @@ -0,0 +1,3 @@ +# Repositories + +_TBD_ diff --git a/docs/docs/guide/backends/event-bus/in-memory.md b/docs/docs/guide/backends/event-bus/in-memory.md new file mode 100644 index 00000000..dc1aee9a --- /dev/null +++ b/docs/docs/guide/backends/event-bus/in-memory.md @@ -0,0 +1,3 @@ +# In-Memory Event Bus + +_TBD_ diff --git a/docs/docs/guide/backends/event-bus/nats.md b/docs/docs/guide/backends/event-bus/nats.md new file mode 100644 index 00000000..d6a900e7 --- /dev/null +++ b/docs/docs/guide/backends/event-bus/nats.md @@ -0,0 +1,3 @@ +# NATS Event Bus + +_TBD_ diff --git a/docs/docs/guide/backends/event-store/in-memory.md b/docs/docs/guide/backends/event-store/in-memory.md new file mode 100644 index 00000000..3e935a11 --- /dev/null +++ b/docs/docs/guide/backends/event-store/in-memory.md @@ -0,0 +1,3 @@ +# In-Memory Event Store + +_TBD_ diff --git a/docs/docs/guide/backends/event-store/mongodb.md b/docs/docs/guide/backends/event-store/mongodb.md new file mode 100644 index 00000000..e23d62df --- /dev/null +++ b/docs/docs/guide/backends/event-store/mongodb.md @@ -0,0 +1,3 @@ +# MongoDB Event Store + +_TBD_ diff --git a/docs/docs/guide/backends/event-store/postgres.md b/docs/docs/guide/backends/event-store/postgres.md new file mode 100644 index 00000000..f20e4483 --- /dev/null +++ b/docs/docs/guide/backends/event-store/postgres.md @@ -0,0 +1,3 @@ +# Postgres Event Store + +_TBD_ diff --git a/docs/docs/guide/commands/readme.md b/docs/docs/guide/commands/readme.md new file mode 100644 index 00000000..6aab5157 --- /dev/null +++ b/docs/docs/guide/commands/readme.md @@ -0,0 +1,8 @@ +::: info +Documentation for commands has not been written yet but you can read the +README of the `command` package below. +::: + +
+ + diff --git a/docs/docs/guide/process-managers/readme.md b/docs/docs/guide/process-managers/readme.md new file mode 100644 index 00000000..4d19d37d --- /dev/null +++ b/docs/docs/guide/process-managers/readme.md @@ -0,0 +1,8 @@ +::: info +Documentation for process anagers has not been written yet but you can read the +README of the `saga` package below. +::: + +
+ + diff --git a/docs/docs/guide/projections/readme.md b/docs/docs/guide/projections/readme.md new file mode 100644 index 00000000..865ed204 --- /dev/null +++ b/docs/docs/guide/projections/readme.md @@ -0,0 +1,8 @@ +::: info +Documentation for projections has not been written yet but you can read the +README of the `projection` package below. +::: + +
+ + diff --git a/docs/postcss.config.js b/docs/postcss.config.js index a4cbb84a..6a62c397 100644 --- a/docs/postcss.config.js +++ b/docs/postcss.config.js @@ -1,3 +1,3 @@ module.exports = { - plugins: { 'postcss-nesting': {}, tailwindcss: {} }, + plugins: [require('postcss-nesting'), require('tailwindcss')], }