Merge branch 'master' into feat/gossip

CHANGELOG.md

@@ -1,3 +1,29 @@
+## [10.5.1](https://github.com/Collektive/collektive/compare/10.5.0...10.5.1) (2024-10-22)
+
+### Dependency updates
+
+* **deps:** update dependency it.unibo.alchemist:alchemist-api to v34.1.7 ([0487e63](https://github.com/Collektive/collektive/commit/0487e63506f662a8228be087d16b7f5914815acc))
+
+### Documentation
+
+* **site:** setup getting started page and enable algola search ([0f8089d](https://github.com/Collektive/collektive/commit/0f8089d7645f01a2f214ebff24f4a89537922a80))
+
+## [10.5.0](https://github.com/Collektive/collektive/compare/10.4.0...10.5.0) (2024-10-21)
+
+### Dependency updates
+
+* **api-deps:** update kotlin to v2.0.20 and Kotest to v6.0.0.M1 ([#518](https://github.com/Collektive/collektive/issues/518)) ([629076b](https://github.com/Collektive/collektive/commit/629076b5bfb239f4f4ad2d23988f21dfc3351c1a))
+* **deps:** update alchemist to v34.1.6 ([6653b67](https://github.com/Collektive/collektive/commit/6653b67425564d19ac2349bf2a464df552554091))
+* **deps:** update dependency @mdx-js/react to v3.1.0 ([998bc35](https://github.com/Collektive/collektive/commit/998bc3539ad8f2ee4acff5785897b7769889747c))
+
+### Build and continuous integration
+
+* use the built-in feature of setup-node to install the correct node engine version ([#519](https://github.com/Collektive/collektive/issues/519)) ([3fdfa8b](https://github.com/Collektive/collektive/commit/3fdfa8b4a2d93b7f33bc6b1c033e46cffa2219bc))
+
+### General maintenance
+
+* **release:** 10.5.0 [skip ci] ([42b3f4b](https://github.com/Collektive/collektive/commit/42b3f4be23b08cbc8fa411b476141e173c49ca11)), closes [#518](https://github.com/Collektive/collektive/issues/518)
+
 ## [10.5.0](https://github.com/Collektive/collektive/compare/10.4.0...10.5.0) (2024-10-20)
 
 ### Dependency updates

gradle/libs.versions.toml

@@ -1,5 +1,5 @@
 [versions]
-alchemist = "34.1.6"
+alchemist = "34.1.8"
 build-config = "5.5.0"
 coroutines = "1.9.0"
 dokka = "1.9.20"

site/docs/about/_category_.json

@@ -1,6 +1,6 @@
 {
   "label": "About",
-  "position": 1,
+  "position": 100,
   "link": {
     "type": "generated-index",
     "description": "TODO"

site/docs/explanation/_category_.json

@@ -1,6 +1,6 @@
 {
   "label": "Explanation",
-  "position": 5,
+  "position": 50,
   "link": {
     "type": "generated-index",
     "description": "TODO"

site/docs/getting-started.mdx

@@ -0,0 +1,79 @@
+---
+sidebar_position: 1
+sidebar_label: Getting Started
+id: gettingstarted
+title: Getting Started
+---
+
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+**Collektive** is composed of several independent components:
+
+- The core _DSL_ (Domain Specific Language) defining the language syntax and semantics.
+- The _compiler plugin_ used to automatically devise the communication protocol based on the program's structure.
+- The _stdlib_ (Standard Library) providing common functionalities and data structures.
+
+## Compiler plugin setup
+
+To use **Collektive** in your project, first add the **compiler plugin** to your `build.gradle.kts` file:
+
+```kotlin
+plugins {
+    kotlin("multiplatform") version "<kotlin_version>"
+    id("it.unibo.collektive.collektive-plugin") version "<latest version>"
+}
+```
+
+:::danger
+The **compiler plugin** it's a mandatory component of the **Collektive** ecosystem. It is used to automatically devise
+the
+communication protocol based on the program's structure.
+
+Without this plugin, the program will **NOT** run as expected at runtime.
+:::
+
+## Dependencies setup
+To start you app development, add the `dsl` and (optionally) the `stdlib` dependencies to your `build.gradle.kts` file:
+
+<Tabs>
+<TabItem value="multiplatform" label="Multiplatform">
+
+```kotlin
+kotlin {
+    jvm()
+    js()
+    ...
+    sourceSets {
+        val commonMain by getting {
+            dependencies {
+                implementation("it.unibo.collektive:dsl:<latest version>")
+                implementation("it.unibo.collektive:stdlib:<latest version>")
+            }
+        }
+    }
+}
+```
+
+</TabItem>
+<TabItem value="jvm" label="JVM only">
+
+```kotlin
+dependencies {
+    implementation("it.unibo.collektive:dsl:<latest version>")
+    implementation("it.unibo.collektive:stdlib:<latest version>")
+}
+```
+
+</TabItem>
+</Tabs>
+
+:::tip[**Collektive** :heart: Kotlin Multiplatform]
+
+**Collektive** supports [KMP](https://kotlinlang.org/docs/multiplatform-intro.html) (Kotlin Multiplatform) projects, allowing you to use the DSL in Native, JS, and JVM environments.       
+Currently, the following platforms are supported:
+- **JVM**
+- **JS** (node.js and browser)
+- **Native** (iOS, macOS, Linux, Windows)
+:::

site/docs/how-to-guide/_category_.json

@@ -1,6 +1,6 @@
 {
   "label": "How To Guide",
-  "position": 4,
+  "position": 40,
   "link": {
     "type": "generated-index",
     "description": "TODO"

site/docs/intro.md

@@ -2,6 +2,6 @@
 sidebar_position: 0
 ---
 
-# Collektive Intro
+# Collektive Introduction
 
 todo

site/docs/introduction/_category_.json

@@ -1,6 +1,6 @@
 {
   "label": "Introduction",
-  "position": 2,
+  "position": 20,
   "link": {
     "type": "generated-index",
     "description": "TODO"

site/docs/reference-guides/_category_.json

@@ -1,6 +1,6 @@
 {
   "label": "Reference",
-  "position": 6,
+  "position": 60,
   "link": {
     "type": "generated-index",
     "description": "TODO"

site/docs/tutorials/_category_.json

@@ -1,6 +1,6 @@
 {
   "label": "Tutorial",
-  "position": 7,
+  "position": 70,
   "link": {
     "type": "generated-index",
     "description": "TODO"