Merge pull request #857 from patchlevel/prepare-docs

Migrate docs from mkdocs to patchlevel.dev

Author: DanielBadura

.github/workflows/docs-build-try.yml

@@ -19,7 +19,7 @@ jobs:
                 dependencies:
                     - "locked"
                 php-version:
-                    - "8.5"
+                    - "8.4"
                 operating-system:
                     - "ubuntu-latest"
 

.github/workflows/docs-build.yml

@@ -19,4 +19,4 @@ jobs:
             -H "Authorization: Bearer ${{ secrets.ORGANIZATION_ADMIN_TOKEN }}" \
             -H "X-GitHub-Api-Version: 2026-03-10" \
             https://api.github.com/repos/patchlevel/patchlevel.dev/actions/workflows/prod-deployment.yaml/dispatches \
-            -d '{"ref":"main"}'
+            -d '{"ref":"main"}'

.github/workflows/docs-check.yml

@@ -23,7 +23,7 @@ if (file_exists($targetDir)) {
 mkdir($targetDir);
 
 $finder = new Symfony\Component\Finder\Finder();
-$finder->files()->in(__DIR__ . '/../docs/pages')->name('*.md');
+$finder->files()->in(__DIR__ . '/../docs')->name('*.md');
 
 foreach ($finder as $file) {
     $fileName = pathinfo($file->getBasename(), PATHINFO_FILENAME);

.github/workflows/docs-deploy.yml

@@ -25,7 +25,7 @@ if (!file_exists($targetDir)) {
 }
 
 $finder = new Symfony\Component\Finder\Finder();
-$finder->files()->in(__DIR__ . '/../docs/pages')->name('*.md');
+$finder->files()->in(__DIR__ . '/../docs')->name('*.md');
 
 foreach ($finder as $file) {
     $fileName = pathinfo($file->getBasename(), PATHINFO_FILENAME);

bin/docs-extract-php-code

@@ -7,12 +7,12 @@ since only an aggregate-wide unique string is expected in the store.
 
 This library provides you with a few options for generating the id.
 
-!!! warning
+:::warning
+Performance reasons, the default configuration of the store require an uuid string for `aggregate id`.
+But technically, for the library, it can be any string.
+If you want to use a custom id, you have to change the `aggregate_id_type` in the [store](store.md) configuration.
+:::
 
-    Performance reasons, the default configuration of the store require an uuid string for `aggregate id`.
-    But technically, for the library, it can be any string.
-    If you want to use a custom id, you have to change the `aggregate_id_type` in the [store](store.md) configuration.
-    
 ## Uuid
 
 The easiest way is to use an `uuid` as an aggregate ID.
@@ -41,11 +41,12 @@ use Patchlevel\EventSourcing\Aggregate\Uuid;
 $uuid = Uuid::generate();
 $uuid = Uuid::fromString('d6e8d7a0-4b0b-4e6a-8a9a-3a0b2d9d0e4e');
 ```
-!!! Note
 
-    We implemented the version 7 of the uuid, because it is most suitable for event sourcing.
-    More information about uuid versions can be found [here](https://uuid.ramsey.dev/en/stable/rfc4122.html).
-    
+:::note
+We implemented the version 7 of the uuid, because it is most suitable for event sourcing.
+More information about uuid versions can be found [here](https://uuid.ramsey.dev/en/stable/rfc4122.html).
+:::
+
 ## Custom ID
 
 If you don't want to use an uuid, you can also use the custom ID implementation.
@@ -64,12 +65,13 @@ final class Profile extends BasicAggregateRoot
     private CustomId $id;
 }
 ```
-!!! warning
 
-    If you want to use a custom id that is not an uuid, 
-    you need to change the `aggregate_id_type` to `string` in the store configuration.
-    More information can be found [here](store.md).
-    
+:::warning
+If you want to use a custom id that is not an uuid, 
+you need to change the `aggregate_id_type` to `string` in the store configuration.
+More information can be found [here](store.md).
+:::
+
 So you can use any string as an id:
 
 ```php