Merge pull request #90 from TraGicCode/learning-transport-documentation

Add documentation for configuring the learning transport within busly

Author: TraGicCode

website/docs/configuration/_category_.json

@@ -0,0 +1,4 @@
+{
+  "label": "Configuration",
+  "position": 3
+}

website/docs/configuration/configuration.md

@@ -0,0 +1,3 @@
+# Configuration
+
+busly-cli uses an application-specific configuration file to store settings such as transport configuration and operational parameters. By default, the CLI looks for the configuration file at `~/.busly-cli/config.yaml`

website/docs/getting-started/_category_.json

@@ -1,8 +1,3 @@
 {
-  "label": "Getting Started",
-  "position": 2,
-  "link": {
-    "type": "generated-index",
-    "description": "Everything you need for getting started with this tool."
-  }
+  "position": 1
 }

website/docs/getting-started/getting-started.mdx

@@ -0,0 +1,7 @@
+import DocCardList from "@theme/DocCardList";
+
+# Getting Started
+
+Everything you need for getting started with this tool.
+
+<DocCardList />

website/docs/getting-started/quick-start.mdx

@@ -67,7 +67,7 @@ busly transport current
 :::note
 This guide uses RabbitMQ for simplicity, but Busly supports multiple NServiceBus transports.
 
-Check out the [Transports section](#) for other options.
+Check out the [Transports section](../transports/) for other options.
 :::
 
 ## Run RabbitMQ

website/docs/introduction.md

@@ -0,0 +1,4 @@
+{
+
+  "position": 3
+}

website/docs/transports/_category_.json

@@ -0,0 +1,58 @@
+# Learning Transport
+
+The **Learning Transport** is a simple file-based transport used mainly for local development and tutorials.
+
+## Configuration
+
+To use the Learning Transport, define it under `transports` and reference it as `current-transport`.
+
+### Example
+
+```yaml
+current-transport: local-learning
+
+transports:
+    - name: local-learning
+      learning-transport-config:
+          storage-directory: C:\Source\tutorials-quickstart\.learningtransport
+          restrict-payload-size: true
+```
+
+---
+
+## `learning-transport-config` Fields
+
+| Field                   | Required | Type    | Default | Description                                                                                           |
+| ----------------------- | -------- | ------- | ------- | ----------------------------------------------------------------------------------------------------- |
+| `storage-directory`     | **Yes**  | string  | —       | Absolute path where Learning Transport stores message files. Busly will not start without this value. |
+| `restrict-payload-size` | No       | boolean | `true`  | Enforces the NServiceBus payload size limit. Set to `false` if you need to send larger payloads.      |
+
+---
+
+## Field Details
+
+### `storage-directory` (required)
+
+This must be an **absolute file path**.
+The Learning Transport stores outgoing and incoming messages in a folder structure at this location.
+If this value is missing, Busly reports an error and exits.
+
+Example:
+
+```yaml
+storage-directory: C:\MyProject\.learningtransport
+```
+
+---
+
+### `restrict-payload-size` (optional, default: `true`)
+
+When enabled (the default), Busly enforces the same message size limits as NServiceBus.
+
+Set to `false` if using large JSON payloads or test messages.
+
+Example:
+
+```yaml
+restrict-payload-size: false
+```

website/docs/transports/learning.md

@@ -0,0 +1,9 @@
+import DocCardList from "@theme/DocCardList";
+
+# Transports
+
+Just like an NServiceBus endpoint, Busly requires a transport configuration before it can send messages. The transport determines how Busly connects to and communicates with your NServiceBus endpoints.
+
+Busly supports the same transports available in NServiceBus. Each transport has its own configuration requirements and capabilities. The sections below provide detailed guides and examples for configuring each transport.
+
+<DocCardList />

website/docs/transports/transports.mdx

@@ -115,7 +115,7 @@ const config = {
                         items: [
                             {
                                 label: "Tutorial",
-                                to: "/docs/introduction",
+                                to: "/docs/getting-started",
                             },
                         ],
                     },