Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions website/docs/configuration/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label": "Configuration",
"position": 3
}
3 changes: 3 additions & 0 deletions website/docs/configuration/configuration.md
Original file line number Diff line number Diff line change
@@ -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`
7 changes: 1 addition & 6 deletions website/docs/getting-started/_category_.json
Original file line number Diff line number Diff line change
@@ -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
}
7 changes: 7 additions & 0 deletions website/docs/getting-started/getting-started.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
import DocCardList from "@theme/DocCardList";

# Getting Started

Everything you need for getting started with this tool.

<DocCardList />
2 changes: 1 addition & 1 deletion website/docs/getting-started/quick-start.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
27 changes: 0 additions & 27 deletions website/docs/introduction.md

This file was deleted.

4 changes: 4 additions & 0 deletions website/docs/transports/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{

"position": 3
}
58 changes: 58 additions & 0 deletions website/docs/transports/learning.md
Original file line number Diff line number Diff line change
@@ -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
```
9 changes: 9 additions & 0 deletions website/docs/transports/transports.mdx
Original file line number Diff line number Diff line change
@@ -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 />
2 changes: 1 addition & 1 deletion website/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ const config = {
items: [
{
label: "Tutorial",
to: "/docs/introduction",
to: "/docs/getting-started",
},
],
},
Expand Down
29 changes: 1 addition & 28 deletions website/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion website/src/pages/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ function HomepageHeader() {
<div className={styles.buttons}>
<Link
className="button button--secondary button--lg"
to="/docs/introduction"
to="/docs/getting-started"
>
Get Started
</Link>
Expand Down