Prepare docs

[DanielBadura]

No description provided.

[github-actions]

Hello 👋

here is the most recent benchmark result:

SplitStreamBench
================

+-------------------------+--------------------+--------------------+-----------+-----------------+------------+-------------+
|                         | time (kde mode)                                     | memory                                     |
+-------------------------+--------------------+--------------------+-----------+-----------------+------------+-------------+
| subject                 | Tag: <current>     | Tag: base          | time-diff | Tag: <current>  | Tag: base  | memory-diff |
+-------------------------+--------------------+--------------------+-----------+-----------------+------------+-------------+
| benchLoad10000Events () | 5.308ms (±0.00%)   | 5.334ms (±0.00%)   | -0.49%    | 35.584mb        | 36.102mb   | -1.43%      |
| benchSave10000Events () | 346.016ms (±0.00%) | 348.647ms (±0.00%) | -0.75%    | 35.651mb        | 35.651mb   | 0.00%       |
+-------------------------+--------------------+--------------------+-----------+-----------------+------------+-------------+

SubscriptionEngineBatchBench
============================

+---------------------------+-------------------+-------------------+-----------+-----------------+------------+-------------+
|                           | time (kde mode)                                   | memory                                     |
+---------------------------+-------------------+-------------------+-----------+-----------------+------------+-------------+
| subject                   | Tag: <current>    | Tag: base         | time-diff | Tag: <current>  | Tag: base  | memory-diff |
+---------------------------+-------------------+-------------------+-----------+-----------------+------------+-------------+
| benchHandle10000Events () | 85.052ms (±0.00%) | 85.386ms (±0.00%) | -0.39%    | 35.544mb        | 35.544mb   | 0.00%       |
+---------------------------+-------------------+-------------------+-----------+-----------------+------------+-------------+

CommandToQueryBench
===================

+----------------+------------------+------------------+-----------+-----------------+------------+-------------+
|                | time (kde mode)                                 | memory                                     |
+----------------+------------------+------------------+-----------+-----------------+------------+-------------+
| subject        | Tag: <current>   | Tag: base        | time-diff | Tag: <current>  | Tag: base  | memory-diff |
+----------------+------------------+------------------+-----------+-----------------+------------+-------------+
| benchCreate () | 2.658ms (±0.00%) | 2.675ms (±0.00%) | -0.65%    | 5.090mb         | 5.090mb    | 0.00%       |
| benchUpdate () | 4.508ms (±0.00%) | 4.629ms (±0.00%) | -2.60%    | 5.026mb         | 5.026mb    | 0.00%       |
| benchBoth ()   | 7.166ms (±0.00%) | 7.250ms (±0.00%) | -1.16%    | 5.014mb         | 5.014mb    | 0.00%       |
+----------------+------------------+------------------+-----------+-----------------+------------+-------------+

NoopSubscriptionEngineBench
===========================

+---------------------------+-------------------+-------------------+-----------+-----------------+------------+-------------+
|                           | time (kde mode)                                   | memory                                     |
+---------------------------+-------------------+-------------------+-----------+-----------------+------------+-------------+
| subject                   | Tag: <current>    | Tag: base         | time-diff | Tag: <current>  | Tag: base  | memory-diff |
+---------------------------+-------------------+-------------------+-----------+-----------------+------------+-------------+
| benchHandle10000Events () | 82.818ms (±0.00%) | 82.254ms (±0.00%) | +0.69%    | 47.560mb        | 47.560mb   | 0.00%       |
+---------------------------+-------------------+-------------------+-----------+-----------------+------------+-------------+

SnapshotsBench
==============

+----------------------------------------+-------------------+-------------------+-----------+-----------------+------------+-------------+
|                                        | time (kde mode)                                   | memory                                     |
+----------------------------------------+-------------------+-------------------+-----------+-----------------+------------+-------------+
| subject                                | Tag: <current>    | Tag: base         | time-diff | Tag: <current>  | Tag: base  | memory-diff |
+----------------------------------------+-------------------+-------------------+-----------+-----------------+------------+-------------+
| benchLoad10000EventsMissingSnapshot () | 64.754ms (±0.00%) | 66.317ms (±0.00%) | -2.36%    | 35.049mb        | 35.049mb   | 0.00%       |
| benchLoad10000Events ()                | 1.210ms (±0.00%)  | 1.201ms (±0.00%)  | +0.72%    | 35.049mb        | 35.049mb   | 0.00%       |
+----------------------------------------+-------------------+-------------------+-----------+-----------------+------------+-------------+

SimpleSetupBench
================

+----------------------------------------+--------------------+--------------------+-----------+-----------------+------------+-------------+
|                                        | time (kde mode)                                     | memory                                     |
+----------------------------------------+--------------------+--------------------+-----------+-----------------+------------+-------------+
| subject                                | Tag: <current>     | Tag: base          | time-diff | Tag: <current>  | Tag: base  | memory-diff |
+----------------------------------------+--------------------+--------------------+-----------+-----------------+------------+-------------+
| benchLoad1Event ()                     | 975.200μs (±0.00%) | 993.600μs (±0.00%) | -1.85%    | 34.979mb        | 34.979mb   | 0.00%       |
| benchLoad10000Events ()                | 65.271ms (±0.00%)  | 65.057ms (±0.00%)  | +0.33%    | 34.979mb        | 34.979mb   | 0.00%       |
| benchSave1Event ()                     | 1.224ms (±0.00%)   | 1.258ms (±0.00%)   | -2.70%    | 34.979mb        | 34.979mb   | 0.00%       |
| benchSave10000Events ()                | 228.639ms (±0.00%) | 230.087ms (±0.00%) | -0.63%    | 34.979mb        | 34.979mb   | 0.00%       |
| benchSave10000Aggregates ()            | 8.855s (±0.00%)    | 8.978s (±0.00%)    | -1.37%    | 34.979mb        | 34.979mb   | 0.00%       |
| benchSave10000AggregatesTransaction () | 5.621s (±0.00%)    | 5.606s (±0.00%)    | +0.25%    | 34.979mb        | 34.979mb   | 0.00%       |
+----------------------------------------+--------------------+--------------------+-----------+-----------------+------------+-------------+

SimpleSetupStreamStoreBench
===========================

+----------------------------------------+--------------------+--------------------+-----------+-----------------+------------+-------------+
|                                        | time (kde mode)                                     | memory                                     |
+----------------------------------------+--------------------+--------------------+-----------+-----------------+------------+-------------+
| subject                                | Tag: <current>     | Tag: base          | time-diff | Tag: <current>  | Tag: base  | memory-diff |
+----------------------------------------+--------------------+--------------------+-----------+-----------------+------------+-------------+
| benchLoad1Event ()                     | 1.138ms (±0.00%)   | 1.110ms (±0.00%)   | +2.50%    | 35.206mb        | 35.206mb   | 0.00%       |
| benchLoad10000Events ()                | 69.475ms (±0.00%)  | 70.806ms (±0.00%)  | -1.88%    | 35.206mb        | 35.206mb   | 0.00%       |
| benchSave1Event ()                     | 1.411ms (±0.00%)   | 1.325ms (±0.00%)   | +6.48%    | 35.206mb        | 35.206mb   | 0.00%       |
| benchSave10000Events ()                | 294.002ms (±0.00%) | 302.851ms (±0.00%) | -2.92%    | 35.206mb        | 35.206mb   | 0.00%       |
| benchSave10000Aggregates ()            | 9.006s (±0.00%)    | 9.027s (±0.00%)    | -0.22%    | 35.206mb        | 35.206mb   | 0.00%       |
| benchSave10000AggregatesTransaction () | 5.763s (±0.00%)    | 5.790s (±0.00%)    | -0.46%    | 35.206mb        | 35.206mb   | 0.00%       |
+----------------------------------------+--------------------+--------------------+-----------+-----------------+------------+-------------+

SubscriptionEngineBench
=======================

+---------------------------+-----------------+-----------------+-----------+-----------------+------------+-------------+
|                           | time (kde mode)                               | memory                                     |
+---------------------------+-----------------+-----------------+-----------+-----------------+------------+-------------+
| subject                   | Tag: <current>  | Tag: base       | time-diff | Tag: <current>  | Tag: base  | memory-diff |
+---------------------------+-----------------+-----------------+-----------+-----------------+------------+-------------+
| benchHandle10000Events () | 3.473s (±0.00%) | 3.499s (±0.00%) | -0.76%    | 47.560mb        | 47.560mb   | 0.00%       |
+---------------------------+-----------------+-----------------+-----------+-----------------+------------+-------------+

PersonalDataBench
=================

+----------------------------------------+--------------------+--------------------+-----------+-----------------+------------+-------------+
|                                        | time (kde mode)                                     | memory                                     |
+----------------------------------------+--------------------+--------------------+-----------+-----------------+------------+-------------+
| subject                                | Tag: <current>     | Tag: base          | time-diff | Tag: <current>  | Tag: base  | memory-diff |
+----------------------------------------+--------------------+--------------------+-----------+-----------------+------------+-------------+
| benchLoad1Event ()                     | 1.251ms (±0.00%)   | 1.243ms (±0.00%)   | +0.63%    | 35.585mb        | 35.585mb   | 0.00%       |
| benchLoad10000Events ()                | 103.872ms (±0.00%) | 103.814ms (±0.00%) | +0.06%    | 35.585mb        | 35.585mb   | 0.00%       |
| benchSave1Event ()                     | 1.933ms (±0.00%)   | 1.872ms (±0.00%)   | +3.27%    | 35.585mb        | 35.585mb   | 0.00%       |
| benchSave10000Events ()                | 259.525ms (±0.00%) | 255.263ms (±0.00%) | +1.67%    | 35.586mb        | 35.586mb   | 0.00%       |
| benchSave10000Aggregates ()            | 13.764s (±0.00%)   | 13.607s (±0.00%)   | +1.16%    | 35.585mb        | 35.585mb   | 0.00%       |
| benchSave10000AggregatesTransaction () | 10.289s (±0.00%)   | 10.244s (±0.00%)   | +0.44%    | 36.044mb        | 36.044mb   | 0.00%       |
+----------------------------------------+--------------------+--------------------+-----------+-----------------+------------+-------------+

This comment gets update everytime a new commit comes in!