docs: prepare docs for release

Author: BEagle1984

.gitignore

@@ -2,11 +2,9 @@
 # Created by https://www.gitignore.io/api/jekyll,visualstudio
 # Edit at https://www.gitignore.io/?templates=jekyll,visualstudio
 
-### Jekyll ###
-_site/
-.sass-cache/
-.jekyll-cache/
-.jekyll-metadata
+### Docs (docfx) ###
+docs/_site/
+docs/build/
 
 ### VisualStudio ###
 ## Ignore Visual Studio temporary files, build results, and

README.md

@@ -1,4 +1,4 @@
-# ![Silverback](https://github.com/BEagle1984/silverback/raw/master/docs/images/logo.png)
+# Silverback
 
 Silverback is a message bus and broker integration library for .NET.
 It helps you build event-driven architectures and asynchronous workflows with first-class support for **Apache Kafka** and **MQTT**.
@@ -20,8 +20,8 @@ Documentation, guides, and samples are available here: **https://silverback-mess
 
 ### Continuous Build
 
-[![Continuous Build Status](https://dev.azure.com/beagle1984/Silverback/_apis/build/status/continuous?branchName=release%2F5.0.0)](https://dev.azure.com/beagle1984/Silverback/_build/latest?definitionId=5&branchName=release%2F5.0.0)
-[![Tests Status (release/5.0.0)](https://img.shields.io/azure-devops/tests/beagle1984/Silverback/5/release%2F5.0.0)](https://dev.azure.com/beagle1984/Silverback/_build/latest?definitionId=5&branchName=release%2F5.0.0)
+[![Continuous Build Status](https://dev.azure.com/beagle1984/Silverback/_apis/build/status/continuous?branchName=master)](https://dev.azure.com/beagle1984/Silverback/_build/latest?definitionId=5&branchName=master)
+[![Tests Status (release/5.0.0)](https://img.shields.io/azure-devops/tests/beagle1984/Silverback/5/master)](https://dev.azure.com/beagle1984/Silverback/_build/latest?definitionId=5&branchName=master)
 
 ### Sonar Build
 
@@ -84,6 +84,10 @@ Testing:
 - **[Silverback.Integration.Kafka.Testing](https://www.nuget.org/packages/Silverback.Integration.Kafka.Testing/)**
 - **[Silverback.Integration.Mqtt.Testing](https://www.nuget.org/packages/Silverback.Integration.Mqtt.Testing/)**
 
+### Supported .NET Versions
+
+Starting with v5, Silverback targets the latest .NET LTS version only.
+
 ### Quick Example (Kafka)
 
 ```csharp

docs/build.ps1

@@ -0,0 +1,4 @@
+dotnet build -c Release ../Silverback.sln --no-incremental -o build
+
+docfx metadata
+docfx --serve --port 4242

docs/changelog/500.md

@@ -8,7 +8,7 @@ uid: releases-500
 
 Silverback 5.0.0 is the most significant update in the library’s history, built on years of user feedback and real-world experience. This release is more than just an upgrade, it’s a **complete refactoring** that enhances flexibility, performance, and maintainability while laying a strong foundation for future innovations.
 
-### ⚡ Highlights
+### Highlights
 
 * An **improved configuration API** that makes it easier to set up Silverback exactly the way you want, with a more intuitive and consistent syntax. The new fluent API is designed to be more readable and straightforward and to giving you more control over the Kafka and MQTT clients that are used under the hood.
 ```csharp
@@ -143,8 +143,13 @@ This release includes many breaking changes, as the library underwent a signific
 
 ### Migration Guide
 
-The migration from Silverback 4.x.x to 5.x.x is a significant step and requires some effort. The following list should give you an overview of the most important steps:
-* _...coming soon..._
+The migration from Silverback 4.x.x to 5.x.x is a significant step and requires some effort. The following list is not exhaustive and might not cover all the [breaking changes](#breaking-changes) but should give you a good idea of the basic steps:
+* Ensure your application targets .NET 10 as starting with v5 Silverback only supports the latest LTS release
+* Upgrade all Silverback.* NuGet packages to 5.x.x
+* Some namespace usings will need to be adjusted (e.g.,Silverback.Messaging.Configuration → Silverback.Configuration)
+* Migrate the endpoints configuration to the new broker clients configuration (an example of the new fluent API can be found in the [Highlights](#highlights) section above)
+* Replace usage of `IEventPublisher`, `ICommandPublisher`, and `IQueryPublisher` with the related extension methods on the basic <xref:Silverback.Messaging.Publishing.IPublisher>
+* If using the outbox, adjust the DbContext / database schema
 
 ### Deprecation Notice
 

docs/docfx.json

@@ -4,9 +4,13 @@
       "src": [
         {
           "files": [
-            "**.csproj"
+            "build/Silverback.*.dll"
           ],
-          "src": "../src"
+          "exclude": [
+            "**.Tests.*.dll",
+            "**.Tests.dll",
+            "**.Tools.*.dll"
+          ]
         }
       ],
       "dest": "api",

docs/guides/broker/default-headers.md

@@ -9,6 +9,8 @@ Here is the list of the default headers that may be sent.
 
 The static classes <xref:Silverback.Messaging.Messages.DefaultMessageHeaders> and <xref:Silverback.Messaging.Messages.KafkaMessageHeaders> contain all default header names constants.
 
+### Default
+
 Header | Name
 :-- | :--
 [MessageType](xref:Silverback.Messaging.Messages.DefaultMessageHeaders#Silverback_Messaging_Messages_DefaultMessageHeaders_MessageType) | `x-message-type`
@@ -24,7 +26,7 @@ Header | Name
 [EncryptionKeyId](xref:Silverback.Messaging.Messages.DefaultMessageHeaders#Silverback_Messaging_Messages_DefaultMessageHeaders_EncryptionKeyId) | `x-encryption-key-id`
 [FailureReason](xref:Silverback.Messaging.Messages.DefaultMessageHeaders#Silverback_Messaging_Messages_DefaultMessageHeaders_FailureReason) | `x-failure-reason`
 
-## Kafka Specific Headers
+### Kafka
 
 Header | Name
 :-- | :--
@@ -36,6 +38,11 @@ Header | Name
 [SourceTimestamp](xref:Silverback.Messaging.Messages.KafkaMessageHeaders#Silverback_Messaging_Messages_KafkaMessageHeaders_SourceTimestamp) | `x-source-timestamp`
 [FirstChunkOffset](xref:Silverback.Messaging.Messages.KafkaMessageHeaders#Silverback_Messaging_Messages_KafkaMessageHeaders_FirstChunkOffset) | `x-chunk-first-offset`
 
+### MQTT
+
+Header | Name
+:-- | :--
+
 ## Customizing Default Header Names
 
 The default header names can be overridden using the `WithCustomHeaderName` configuration method.

docs/guides/broker/producing/outbox.md

@@ -31,16 +31,17 @@ services
     .AddSilverback()
     .WithConnectionToMessageBroker(options => options
         .AddKafka()
-        .AddPostgreSqlOutbox()
+        .AddEntityFrameworkOutbox()
         .AddOutboxWorker(worker => worker
             .ProcessOutbox(outbox => outbox
-                .UsePostgreSql(connectionString)))))
+                .UseEntityFramework<AppDbContext>()))))
     .AddKafkaClients(clients => clients
         .WithBootstrapServers("PLAINTEXT://localhost:9092")
         .AddProducer("producer1", producer => producer
             .Produce<MyMessage>("endpoint1", endpoint => endpoint
                 .ProduceTo("my-topic")
-                .StoreToOutbox(outbox => outbox.UsePostgreSql(connectionString)))));
+                .StoreToOutbox(outbox => outbox
+                    .UseEntityFramework<AppDbContext>()))));
 ```
 # [PostgreSQL](#tab/postgres)
 ```csharp
@@ -57,7 +58,8 @@ services
         .AddProducer("producer1", producer => producer
             .Produce<MyMessage>("endpoint1", endpoint => endpoint
                 .ProduceTo("my-topic")
-                .StoreToOutbox(outbox => outbox.UsePostgreSql(connectionString)))));
+                .StoreToOutbox(outbox => outbox
+                    .UsePostgreSql(connectionString)))));
 ```
 # [Sqlite](#tab/sqlite)
 ```csharp

docs/index.md

@@ -31,7 +31,7 @@ title: "Home"
 > The v4 documentation is still browsable here: [silverback-messaging.net/v4](/v4)
 
 > [!Important]
-> v5 is in beta and the documentation is still being updated. Some sections may be incomplete or not fully aligned with the latest API.
+> The documentation update for v5 is still in progress. Some sections may be missing or incomplete. Please notify us if you find any mistake or inconsistency.
 
 Silverback is a message bus and broker integration library for .NET.
 It is designed to simplify event-driven architectures and asynchronous messaging, with first-class support for **Apache Kafka** and **MQTT**.
@@ -58,6 +58,15 @@ Kafka is a first-class citizen: features like partition-based parallelism, keys/
 - **Distributed tracing** via `System.Diagnostics`.
 - **Testing support** with in-memory brokers and helper APIs.
 
+## Supported .NET Versions
+
+Starting with v5, Silverback targets the **latest .NET LTS** (Long-Term Support) version only.
+
+The library is built and tested against the current LTS release.
+It can run on newer compatible .NET versions (including STS releases), but older frameworks are no longer targeted or supported.
+
+This policy reduces maintenance overhead and keeps Silverback aligned with the .NET platform lifecycle.
+
 ## Getting Started
 
 - <xref:setup> – core concepts and configuration.

docs/v4/about.html

@@ -1,36 +1,36 @@
-<!DOCTYPE html>
+<!DOCTYPE html>
 <!--[if IE]><![endif]-->
 <html>
-  
+
   <head>
     <meta charset="utf-8">
     <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
     <title>About | Silverback </title>
     <meta name="viewport" content="width=device-width">
     <meta name="title" content="About | Silverback ">
-    <meta name="generator" content="docfx 2.59.4.0">
-    
+    <meta name="generator" content="docfx ">
 
+
     <link rel="apple-touch-icon" sizes="180x180" href="images/icons/apple-touch-icon.png">
     <link rel="icon" type="image/png" sizes="32x32" href="images/icons/favicon-32x32.png">
     <link rel="icon" type="image/png" sizes="16x16" href="images/icons/favicon-16x16.png">
     <link rel="manifest" href="images/icons/site.webmanifest">
     <link rel="mask-icon" href="images/icons/safari-pinned-tab.svg" color="#5bbad5">
-  
+
     <link rel="stylesheet" href="styles/docfx.vendor.css">
     <link rel="stylesheet" href="styles/docfx.css">
     <link rel="stylesheet" href="styles/main.css">
     <meta property="docfx:navrel" content="toc.html">
     <meta property="docfx:tocrel" content="toc.html">
-    
-    <meta property="docfx:rel" content="">
-    
+  
+  <meta property="docfx:rel" content="">
+  
     <script src="https://kit.fontawesome.com/e3306be642.js" crossorigin="anonymous"></script>
   </head>
   <body data-spy="scroll" data-target="#affix" data-offset="120">
     <div id="wrapper">
       <header>
-        
+
         <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
           <div class="container">
             <div class="navbar-header">
@@ -40,7 +40,7 @@
                 <span class="icon-bar"></span>
                 <span class="icon-bar"></span>
               </button>
-              
+
               <a class="navbar-brand" href="index.html">
                 <img id="logo" class="svg" src="images/logo.png" alt="">
               </a>
@@ -54,7 +54,7 @@
             </div>
           </div>
         </nav>
-        
+
         <div class="subnav navbar navbar-default">
           <div class="container hide-when-search" id="breadcrumb">
             <ul class="breadcrumb">
@@ -64,7 +64,7 @@
         </div>
       </header>
       <div class="container body-content">
-        
+
         <div id="search-results">
           <div class="search-list"></div>
           <div class="sr-items">
@@ -105,7 +105,7 @@ <h2 id="special-thanks">Special Thanks</h2>
 </ul>
 </article>
           </div>
-          
+
           <div class="hidden-sm col-md-2" role="complementary">
             <div class="sideaffix">
               <div class="contribution">
@@ -122,7 +122,7 @@ <h2 id="special-thanks">Special Thanks</h2>
           </div>
         </div>
       </div>
-      
+
       <footer>
         <div class="footer">
           <div class="container contacts">
@@ -133,13 +133,13 @@ <h2 id="special-thanks">Special Thanks</h2>
             <span class="pull-right">
               <a href="#top">&uarr; Back to top</a>
             </span>
-            © 2020 Sergio Aquilini
-            
+      © 2020 Sergio Aquilini
+      
           </div>
         </div>
       </footer>
     </div>
-    
+
     <script type="text/javascript" src="styles/docfx.vendor.js"></script>
     <script type="text/javascript" src="styles/docfx.js"></script>
     <script type="text/javascript" src="styles/main.js"></script>