Merge pull request #152 from castore-dev/finish-docs

patch: Finish docs

docs/docs/2-installation.md → docs/docs/1-installation.md

@@ -1,5 +1,5 @@
 ---
-sidebar_position: 2
+sidebar_position: 1
 ---
 
 # Installation

docs/docs/3-event-sourcing/1-events.md → docs/docs/2-event-sourcing/1-events.md

@@ -53,7 +53,7 @@ const pokemonAppearedEventType = new EventType<
 
 :::info
 
-Note that we only provided TS types for `payload` and `metadata` properties. That is because, as stated in the [core design](../1-introduction.md#-core-design), **Castore is meant to be as flexible as possible**, and that includes the validation library you want to use (if any): The `EventType` class can be used directly if no validation is required, or implemented by [other classes](../5-packages.md#-event-types) which will add run-time validation methods to it 👍
+Note that we only provided TS types for `payload` and `metadata` properties. That is because, as stated in the [core design](../../../), **Castore is meant to be as flexible as possible**, and that includes the validation library you want to use (if any): The `EventType` class can be used directly if no validation is required, or implemented by [other classes](../4-packages.md#-event-types) which will add run-time validation methods to it 👍
 
 :::
 

docs/docs/3-event-sourcing/4-fetching-events.md → docs/docs/2-event-sourcing/4-fetching-events.md

@@ -30,6 +30,6 @@ const { aggregate } = await pokemonsEventStore.getAggregate('pikachu1');
 
 :::info
 
-You can choose to build an event storage adapter that suits your usage. However, we highly recommend using an [off-the-shelf adapter](../5-packages.md#-event-storage-adapters) (if the storage solution that you use does not have an adapter yet, feel free to create/upvote an issue, or contribute 🤗).
+You can choose to build an event storage adapter that suits your usage. However, we highly recommend using an [off-the-shelf adapter](../4-packages.md#-event-storage-adapters) (if the storage solution that you use does not have an adapter yet, feel free to create/upvote an issue, or contribute 🤗).
 
 :::

docs/docs/3-event-sourcing/5-pushing-events.md → docs/docs/2-event-sourcing/5-pushing-events.md

@@ -47,11 +47,11 @@ const catchPokemonCommand = new Command({
 
 :::info
 
-Note that we only provided TS types for `Input` and `Output` properties. That is because, as stated in the [core design](../1-introduction.md#-core-design), **Castore is meant to be as flexible as possible**, and that includes the validation library you want to use (if any): The `Command` class can be used directly if no validation is required, or implemented by [other classes](../5-packages.md#-commands) which will add run-time validation methods to it 👍
+Note that we only provided TS types for `Input` and `Output` properties. That is because, as stated in the [core design](../../../), **Castore is meant to be as flexible as possible**, and that includes the validation library you want to use (if any): The `Command` class can be used directly if no validation is required, or implemented by [other classes](../4-packages.md#-commands) which will add run-time validation methods to it 👍
 
 :::
 
-`Commands` handlers should NOT use [read models](../4-reacting-to-events/6-read-models.md) when validating that a modification is acceptable. Read models are like cache: They are not the source of truth, and may not represent the freshest state.
+`Commands` handlers should NOT use [read models](../3-reacting-to-events/6-read-models.md) when validating that a modification is acceptable. Read models are like cache: They are not the source of truth, and may not represent the freshest state.
 
 Fetching and pushing events non-simultaneously exposes your application to [race conditions](https://en.wikipedia.org/wiki/Race_condition). To counter that, commands are designed to be retried when an `EventAlreadyExistsError` is triggered (which is part of the `EventStorageAdapter` interface).
 

docs/docs/3-event-sourcing/_category_.json → docs/docs/2-event-sourcing/_category_.json

@@ -1,4 +1,4 @@
 {
   "label": "Event Sourcing concepts",
-  "position": 3
+  "position": 2
 }

docs/docs/4-reacting-to-events/2-message-queues.md → docs/docs/3-reacting-to-events/2-message-queues.md

@@ -53,7 +53,7 @@ await messageQueue.publishMessage(...);
 
 :::info
 
-You can code your own `MessageQueueAdapter` (simply implement the `MessageChannelAdapter` interface), but we highly recommend using an [off-the-shelf adapter](../5-packages.md#-message-queue-adapters) (if the messaging solution that you use does not have an adapter yet, feel free to create/upvote an issue, or contribute 🤗).
+You can code your own `MessageQueueAdapter` (simply implement the `MessageChannelAdapter` interface), but we highly recommend using an [off-the-shelf adapter](../4-packages.md#-message-queue-adapters) (if the messaging solution that you use does not have an adapter yet, feel free to create/upvote an issue, or contribute 🤗).
 
 :::
 
@@ -129,7 +129,7 @@ The following methods interact with the messaging solution of your application t
 
 **Type Helpers:**
 
-- <code>MessageChannelMessage</code>: Given a <code>MessageQueue</code>, returns the TS type of its messages
+- `MessageChannelMessage`: Given a `MessageQueue`, returns the TS type of its messages
 
 ```ts
 import type { MessageChannelMessage } from '@castore/core';

docs/docs/4-reacting-to-events/3-message-buses.md → docs/docs/3-reacting-to-events/3-message-buses.md

@@ -53,7 +53,7 @@ await messageBus.publishMessage(...);
 
 :::info
 
-You can code your own `MessageBusAdapter` (simply implement the `MessageChannelAdapter` interface), but we highly recommend using an [off-the-shelf adapter](../5-packages.md#-message-buses-adapters) (if the messaging solution that you use is missing, feel free to create/upvote an issue, or contribute 🤗).
+You can code your own `MessageBusAdapter` (simply implement the `MessageChannelAdapter` interface), but we highly recommend using an [off-the-shelf adapter](../4-packages.md#-message-buses-adapters) (if the messaging solution that you use is missing, feel free to create/upvote an issue, or contribute 🤗).
 
 :::
 
@@ -125,7 +125,7 @@ The following methods interact with the messaging solution of your application t
 
 **Type Helpers:**
 
-- <code>MessageChannelMessage</code>: Given a <code>MessageBus</code>, returns the TS type of its messages
+- `MessageChannelMessage`: Given a `MessageBus`, returns the TS type of its messages
 
 ```ts
 import type { MessageChannelMessage } from '@castore/core';

docs/docs/4-reacting-to-events/_category_.json → docs/docs/3-reacting-to-events/_category_.json

@@ -1,4 +1,4 @@
 {
   "label": "Reacting to events",
-  "position": 4
+  "position": 3
 }

docs/docs/5-packages.md → docs/docs/4-packages.md

@@ -1,5 +1,5 @@
 ---
-sidebar_position: 5
+sidebar_position: 4
 ---
 
 # Packages

docs/docusaurus.config.js

@@ -2,6 +2,14 @@
 // @ts-check
 // Note: type annotations allow type checking and IDEs autocompletion
 
+const lightCodeTheme = require('prism-react-renderer/themes/vsLight');
+const darkCodeTheme = require('prism-react-renderer/themes/vsDark');
+
+// @ts-expect-error bad typing
+lightCodeTheme.plain.backgroundColor = '#f8f8f8';
+// @ts-expect-error bad typing
+darkCodeTheme.plain.backgroundColor = '#242424';
+
 /** @type {import('@docusaurus/types').Config} */
 const config = {
   title: 'Castore',
@@ -50,7 +58,6 @@ const config = {
   themeConfig:
     /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
     ({
-      // Replace with your project's social card
       image: 'img/castore-social-card.jpg',
       navbar: {
         hideOnScroll: true,
@@ -76,143 +83,8 @@ const config = {
         ],
       },
       prism: {
-        theme: {
-          plain: {
-            color: '#393A34',
-            backgroundColor: '#f6f8fa',
-          },
-          styles: [
-            {
-              types: ['comment', 'prolog', 'doctype', 'cdata'],
-              style: {
-                color: '#999988',
-                fontStyle: 'italic',
-              },
-            },
-            {
-              types: ['namespace'],
-              style: {
-                opacity: 0.7,
-              },
-            },
-            {
-              types: ['string', 'attr-value'],
-              style: {
-                color: '#e3116c',
-              },
-            },
-            {
-              types: ['punctuation', 'operator'],
-              style: {
-                color: '#393A34',
-              },
-            },
-            {
-              types: [
-                'entity',
-                'url',
-                'symbol',
-                'number',
-                'boolean',
-                'variable',
-                'constant',
-                'property',
-                'regex',
-                'inserted',
-              ],
-              style: {
-                color: '#36acaa',
-              },
-            },
-            {
-              types: ['atrule', 'keyword', 'attr-name', 'selector'],
-              style: {
-                color: '#00a4db',
-              },
-            },
-            {
-              types: ['function', 'deleted', 'tag'],
-              style: {
-                color: '#d73a49',
-              },
-            },
-            {
-              types: ['function-variable'],
-              style: {
-                color: '#6f42c1',
-              },
-            },
-            {
-              types: ['tag', 'selector', 'keyword'],
-              style: {
-                color: '#00009f',
-              },
-            },
-          ],
-        },
-        darkTheme: {
-          plain: {
-            color: '#F8F8F2',
-            backgroundColor: '#282A36',
-          },
-          styles: [
-            {
-              types: ['prolog', 'constant', 'builtin'],
-              style: {
-                color: 'rgb(189, 147, 249)',
-              },
-            },
-            {
-              types: ['inserted', 'function'],
-              style: {
-                color: 'rgb(80, 250, 123)',
-              },
-            },
-            {
-              types: ['deleted'],
-              style: {
-                color: 'rgb(255, 85, 85)',
-              },
-            },
-            {
-              types: ['changed'],
-              style: {
-                color: 'rgb(255, 184, 108)',
-              },
-            },
-            {
-              types: ['punctuation', 'symbol'],
-              style: {
-                color: 'rgb(248, 248, 242)',
-              },
-            },
-            {
-              types: ['string', 'char', 'tag', 'selector'],
-              style: {
-                color: 'rgb(255, 121, 198)',
-              },
-            },
-            {
-              types: ['keyword', 'variable'],
-              style: {
-                color: 'rgb(189, 147, 249)',
-                fontStyle: 'italic',
-              },
-            },
-            {
-              types: ['comment'],
-              style: {
-                color: 'rgb(98, 114, 164)',
-              },
-            },
-            {
-              types: ['attr-name'],
-              style: {
-                color: 'rgb(241, 250, 140)',
-              },
-            },
-          ],
-        },
+        theme: lightCodeTheme,
+        darkTheme: darkCodeTheme,
       },
       algolia: {
         // The application ID provided by Algolia

docs/package.json

@@ -43,9 +43,10 @@
     "@docusaurus/preset-classic": "2.4.1",
     "@mdx-js/react": "^1.6.22",
     "@mui/material": "^5.6.3",
-    "clsx": "^1.2.1",
+    "prism-react-renderer": "^1.3.5",
     "react": "^17.0.2",
     "react-dom": "^17.0.2",
+    "react-icons": "^4.11.0",
     "uuid": "^9.0.0",
     "web-vitals": "^2.1.4"
   },