add start of docs

pwelter34 · pwelter34 · commit 9d531a1e81d1 · 2025-04-28T18:51:19.000-05:00
diff --git a/.github/workflows/dotnet.yml b/.github/workflows/dotnet.yml
@@ -55,6 +55,21 @@ jobs:
           name: packages
           path: "${{env.BUILD_PATH}}"
 
+      - name: Install docfx
+        if: success() && github.event_name != 'pull_request' && (github.ref == 'refs/heads/main' || startsWith(github.ref, 'refs/tags/v'))
+        run: dotnet tool update -g docfx
+
+      - name: Create Documentation
+        if: success() && github.event_name != 'pull_request' && (github.ref == 'refs/heads/main' || startsWith(github.ref, 'refs/tags/v'))
+        run: docfx docs/docfx.json
+
+      - name: Upload Documentation
+        if: success() && github.event_name != 'pull_request' && (github.ref == 'refs/heads/main' || startsWith(github.ref, 'refs/tags/v'))
+        uses: actions/upload-pages-artifact@v3
+        with:
+          name: github-pages
+          path: "docs/_site/"
+
   deploy:
     runs-on: ubuntu-latest
     needs: build
@@ -87,3 +102,21 @@ jobs:
             echo "${0##*/}": Pushing $package...
             dotnet nuget push $package --source https://api.nuget.org/v3/index.json --api-key ${{ secrets.NUGET_KEY }} --skip-duplicate
           done
+
+  pages:
+    runs-on: ubuntu-latest
+    needs: build
+    if: success() && github.event_name != 'pull_request' && (github.ref == 'refs/heads/main' || startsWith(github.ref, 'refs/tags/v'))
+
+    permissions:
+      pages: write
+      id-token: write
+
+    steps:
+      - name: Deploy Documentation
+        id: deployment
+        uses: actions/deploy-pages@v4
+
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
diff --git a/docs/assets/logo.png b/docs/assets/logo.png
diff --git a/docs/docfx.json b/docs/docfx.json
@@ -0,0 +1,52 @@
+{
+  "metadata": [
+    {
+      "src": [
+        {
+          "files": [
+            "**/*.csproj"
+          ],
+          "exclude": [
+            "**/bin/**",
+            "**/obj/**"
+          ],
+          "src": "../src"
+        }
+      ],
+      "dest": "reference",
+      "properties": {
+        "TargetFramework": "net9.0"
+      }
+    }
+  ],
+  "build": {
+    "content": [
+      "**/*.{md,yml}"
+    ],
+    "resource": [
+      "**/assets/**"
+    ],
+    "postProcessors": [
+      "ExtractSearchIndex"
+    ],
+    "globalMetadata": {
+      "_appTitle": "Arbiter",
+      "_appName": "Arbiter",
+      "_appFooter": "Copyright &copy; 2025 LoreSoft",
+      "_appLogoPath": "assets/logo.png",
+      "_appFaviconPath": "assets/logo.png",
+      "_enableSearch": true
+    },
+    "sitemap": {
+      "baseUrl": "https://loresoft.com/Arbiter",
+      "priority": 0.5,
+      "changefreq": "daily"
+    },
+    "output": "_site",
+    "template": [
+      "default",
+      "modern",
+      "template"
+    ]
+  }
+}
diff --git a/docs/guide/behaviors/abstracts.md b/docs/guide/behaviors/abstracts.md
@@ -0,0 +1,3 @@
+# Behavior Abstracts
+
+Abstract base classes for behaviors
diff --git a/docs/guide/behaviors/audit.md b/docs/guide/behaviors/audit.md
@@ -0,0 +1,3 @@
+# Audit Behavior
+
+Behavior for automatically setting created and updated properties
diff --git a/docs/guide/behaviors/caching.md b/docs/guide/behaviors/caching.md
@@ -0,0 +1 @@
+# Caching Behavior
diff --git a/docs/guide/behaviors/delete.md b/docs/guide/behaviors/delete.md
@@ -0,0 +1 @@
+# Soft Delete Behavior
diff --git a/docs/guide/behaviors/tenant.md b/docs/guide/behaviors/tenant.md
@@ -0,0 +1 @@
+# Multi Tenant Behavior
diff --git a/docs/guide/behaviors/validation.md b/docs/guide/behaviors/validation.md
@@ -0,0 +1 @@
+# Validation Behavior
diff --git a/docs/guide/commands/abstracts.md b/docs/guide/commands/abstracts.md
@@ -0,0 +1,3 @@
+# Command Abstracts
+
+Abstract base classes for commands
diff --git a/docs/guide/commands/create.md b/docs/guide/commands/create.md
@@ -0,0 +1 @@
+# Create Command
diff --git a/docs/guide/commands/delete.md b/docs/guide/commands/delete.md
@@ -0,0 +1 @@
+# Delete Command
diff --git a/docs/guide/commands/patch.md b/docs/guide/commands/patch.md
@@ -0,0 +1 @@
+# Patch Command
diff --git a/docs/guide/commands/update.md b/docs/guide/commands/update.md
@@ -0,0 +1 @@
+# Update Command
diff --git a/docs/guide/commands/upsert.md b/docs/guide/commands/upsert.md
@@ -0,0 +1 @@
+# Upsert Command
diff --git a/docs/guide/handlers/entityFramework.md b/docs/guide/handlers/entityFramework.md
@@ -0,0 +1 @@
+# Entity Framework Core Handlers
diff --git a/docs/guide/handlers/mongo.md b/docs/guide/handlers/mongo.md
@@ -0,0 +1 @@
+# MongoDB Handlers
diff --git a/docs/guide/index.md b/docs/guide/index.md
@@ -0,0 +1,240 @@
+# Arbiter
+
+Mediator pattern and Command Query Responsibility Segregation (CQRS) implementation in .NET
+
+| Library                                                                                                      | Package                                                                                                                                                                                  | Description                                                       |
+| :----------------------------------------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :---------------------------------------------------------------- |
+| [Arbiter.Mediation](https://www.nuget.org/packages/Arbiter.Mediation/)                                       | [![Arbiter.Mediation](https://img.shields.io/nuget/v/Arbiter.Mediation.svg)](https://www.nuget.org/packages/Arbiter.Mediation/)                                                          | Lightweight and extensible implementation of the Mediator pattern |
+| [Arbiter.Mediation.OpenTelemetry](https://www.nuget.org/packages/Arbiter.Mediation.OpenTelemetry/)           | [![Arbiter.Mediation.OpenTelemetry](https://img.shields.io/nuget/v/Arbiter.Mediation.OpenTelemetry.svg)](https://www.nuget.org/packages/Arbiter.Mediation.OpenTelemetry/)                | OpenTelemetry support for Arbiter.Mediation library               |
+| [Arbiter.CommandQuery](https://www.nuget.org/packages/Arbiter.CommandQuery/)                                 | [![Arbiter.CommandQuery](https://img.shields.io/nuget/v/Arbiter.CommandQuery.svg)](https://www.nuget.org/packages/Arbiter.CommandQuery/)                                                 | Base package for Commands, Queries and Behaviors                  |
+| [Arbiter.CommandQuery.EntityFramework](https://www.nuget.org/packages/Arbiter.CommandQuery.EntityFramework/) | [![Arbiter.CommandQuery.EntityFramework](https://img.shields.io/nuget/v/Arbiter.CommandQuery.EntityFramework.svg)](https://www.nuget.org/packages/Arbiter.CommandQuery.EntityFramework/) | Entity Framework Core handlers for the base Commands and Queries  |
+| [Arbiter.CommandQuery.MongoDB](https://www.nuget.org/packages/Arbiter.CommandQuery.MongoDB/)                 | [![Arbiter.CommandQuery.MongoDB](https://img.shields.io/nuget/v/Arbiter.CommandQuery.MongoDB.svg)](https://www.nuget.org/packages/Arbiter.CommandQuery.MongoDB/)                         | Mongo DB handlers for the base Commands and Queries               |
+| [Arbiter.CommandQuery.Endpoints](https://www.nuget.org/packages/Arbiter.CommandQuery.Endpoints/)             | [![Arbiter.CommandQuery.Endpoints](https://img.shields.io/nuget/v/Arbiter.CommandQuery.Endpoints.svg)](https://www.nuget.org/packages/Arbiter.CommandQuery.Endpoints/)                   | Minimal API endpoints for base Commands and Queries               |
+
+## Arbiter.Mediation
+
+A lightweight and extensible implementation of the Mediator pattern for .NET applications, designed for clean, modular architectures like Vertical Slice Architecture and CQRS.
+
+### Mediation Installation
+
+The Arbiter Mediation library is available on nuget.org via package name `Arbiter.Mediation`.
+
+To install Arbiter Mediation, run the following command in the Package Manager Console
+
+```powershell
+Install-Package Arbiter.Mediation
+```
+
+OR
+
+```shell
+dotnet add package Arbiter.Mediation
+```
+
+### Mediation Features
+
+- Request with response handling using `IRequest<TResponse>` and `IRequestHandler<TRequest, TResponse>`
+- Notifications (Events) using `INotification` and `INotificationHandler<TNotification>`
+- Pipeline Behaviors, like middleware, using `IPipelineBehavior<TRequest, TResponse>`
+- Dependence Injection based resolution of handlers and behaviors via scoped `IServiceProvider`
+- Supports OpenTelemetry tracing and meters via `Arbiter.Mediation.OpenTelemetry`
+
+### Define Request
+
+```csharp
+public class Ping : IRequest<Pong>
+{
+    public string? Message { get; set; }
+}
+```
+
+### Implement Handler
+
+```csharp
+public class PingHandler : IRequestHandler<Ping, Pong>
+{
+    public async ValueTask<Pong> Handle(
+        Ping request,
+        CancellationToken cancellationToken = default)
+    {
+        // Simulate some work
+        await Task.Delay(100, cancellationToken);
+
+        return new Pong { Message = $"{request.Message} Pong" };
+    }
+}
+```
+
+### Define Pipeline Behavior
+
+```csharp
+public class PingBehavior : IPipelineBehavior<Ping, Pong>
+{
+    public async ValueTask<Pong> Handle(
+        Ping request,
+        RequestHandlerDelegate<Pong> next,
+        CancellationToken cancellationToken = default)
+    {
+        // Do something before the request is handled
+        var response = await next(cancellationToken);
+        // Do something after the request is handled
+
+        return response;
+    }
+}
+```
+
+### Register Handlers
+
+```csharp
+public class Startup
+{
+    public void ConfigureServices(IServiceCollection services)
+    {
+        // Register Arbiter services
+        services.AddArbiter();
+
+        // Register handlers
+        services.TryAddTransient<IRequestHandler<Ping, Pong>, PingHandler>();
+
+        // Optionally register pipeline behaviors, supports multiple behaviors
+        services.AddTransient<IPipelineBehavior<Ping, Pong>, PingBehavior>();
+    }
+}
+```
+
+### Send Request
+
+```csharp
+public class PingController : ControllerBase
+{
+    private readonly IMediator _mediator;
+
+    public PingController(IMediator mediator)
+    {
+        _mediator = mediator;
+    }
+
+    [HttpGet]
+    public async Task<IActionResult> Get(
+        string? message = null,
+        CancellationToken? cancellationToken = default)
+    {
+        var request = new Ping { Message = message };
+        var response = await _mediator.Send<Ping, Pong>(request, cancellationToken);
+
+        return Ok(response);
+    }
+}
+```
+
+## Arbiter.Mediation.OpenTelemetry
+
+OpenTelemetry support for Arbiter.Mediation library
+
+### OpenTelemetry Installation
+
+```powershell
+Install-Package Arbiter.Mediation.OpenTelemetry
+```
+
+OR
+
+```shell
+dotnet add package Arbiter.Mediation.OpenTelemetry
+```
+
+### OpenTelemetry Usage
+
+Register via dependency injection
+
+```c#
+services.AddMediatorDiagnostics();
+
+services.AddOpenTelemetry()
+  .WithTracing(tracing => tracing
+    .AddMediatorInstrumentation()
+    .AddConsoleExporter()
+  )
+  .WithMetrics(metrics => metrics
+    .AddMediatorInstrumentation()
+    .AddConsoleExporter()
+  );
+```
+
+## Arbiter.CommandQuery
+
+Command Query Responsibility Segregation (CQRS) framework based on mediator pattern
+
+### CommandQuery Installation
+
+The Arbiter Command Query library is available on nuget.org via package name `Arbiter.CommandQuery`.
+
+To install Arbiter Command Query, run the following command in the Package Manager Console
+
+```powershell
+Install-Package Arbiter.CommandQuery
+```
+
+OR
+
+```shell
+dotnet add package Arbiter.CommandQuery
+```
+
+### CommandQuery Features
+
+- Base commands and queries for common CRUD operations
+- Generics base handlers for implementing common CRUD operations
+- Common behaviors for audit, caching, soft delete, multi-tenant
+- View model to data modal mapping
+- Entity Framework Core handlers for common CRUD operations
+- MongoDB handlers for common CRUD operations
+
+## Arbiter.CommandQuery.EntityFramework
+
+Entity Framework Core handlers for the base Commands and Queries
+
+### EntityFramework Installation
+
+```powershell
+Install-Package Arbiter.CommandQuery.EntityFramework
+```
+
+OR
+
+```shell
+dotnet add package Arbiter.CommandQuery.EntityFramework
+```
+
+## Arbiter.CommandQuery.MongoDB
+
+Mongo DB handlers for the base Commands and Queries
+
+### MongoDB Installation
+
+```powershell
+Install-Package Arbiter.CommandQuery.MongoDB
+```
+
+OR
+
+```shell
+dotnet add package Arbiter.CommandQuery.MongoDB
+```
+
+## Arbiter.CommandQuery.Endpoints
+
+Minimal API endpoints for base Commands and Queries
+
+### Endpoints Installation
+
+```powershell
+Install-Package Arbiter.CommandQuery.Endpoints
+```
+
+OR
+
+```shell
+dotnet add package Arbiter.CommandQuery.Endpoints
+```
diff --git a/docs/guide/queries/abstracts.md b/docs/guide/queries/abstracts.md
@@ -0,0 +1,3 @@
+# Query Abstract Classes
+
+Abstract base classes for queries
diff --git a/docs/guide/queries/caching.md b/docs/guide/queries/caching.md
@@ -0,0 +1 @@
+# Query Result Caching
diff --git a/docs/guide/queries/filters.md b/docs/guide/queries/filters.md
@@ -0,0 +1 @@
+# Query Filters
diff --git a/docs/guide/queries/identifier.md b/docs/guide/queries/identifier.md
@@ -0,0 +1 @@
+# Identifier Query
diff --git a/docs/guide/queries/identifiers.md b/docs/guide/queries/identifiers.md
@@ -0,0 +1 @@
+# Identifiers Query
diff --git a/docs/guide/queries/list.md b/docs/guide/queries/list.md
@@ -0,0 +1 @@
+# List Query
diff --git a/docs/guide/queries/paged.md b/docs/guide/queries/paged.md
@@ -0,0 +1 @@
+# Paged Query
diff --git a/docs/guide/quickStart.md b/docs/guide/quickStart.md
@@ -0,0 +1 @@
+# Quick Start
diff --git a/docs/guide/scripts.md b/docs/guide/scripts.md
@@ -0,0 +1 @@
+# Scripts
diff --git a/docs/guide/toc.yml b/docs/guide/toc.yml
diff --git a/docs/index.md b/docs/index.md
diff --git a/docs/reference/.gitignore b/docs/reference/.gitignore
diff --git a/docs/reference/index.md b/docs/reference/index.md
diff --git a/docs/template/public/main.css b/docs/template/public/main.css
diff --git a/docs/toc.yml b/docs/toc.yml
diff --git a/templates/DomainJsonContext.csx b/templates/DomainJsonContext.csx
diff --git a/templates/EntityEndpoint.csx b/templates/EntityEndpoint.csx

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# Behavior Abstracts`
	`2`	`+`
	`3`	`+Abstract base classes for behaviors`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# Audit Behavior`
	`2`	`+`
	`3`	`+Behavior for automatically setting created and updated properties`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# Command Abstracts`
	`2`	`+`
	`3`	`+Abstract base classes for commands`