From f1b525a6f37d3a117f4e0c6f4101ce6903984f35 Mon Sep 17 00:00:00 2001 From: Mauro Servienti Date: Fri, 1 Nov 2024 17:59:52 +0100 Subject: [PATCH 1/2] Refactor the docs README --- docs/README.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/docs/README.md b/docs/README.md index 0e2f38d6..21cb3fc8 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,15 +1,16 @@ -# ASP.NET Core on .NET +# Documentation -ServiceComposer leverages the Endpoints support to plugin into the request handling pipeline. -ServiceComposer can be added to existing or new ASP.NET Core projects, or it can be hosted in .NET console applications. +## Hosting + +ServiceComposer leverages the ASP.NET Core Endpoints support to plugin into the request handling pipeline. ServiceComposer can be added to existing or new ASP.NET Core projects, or it can be hosted standalone in .NET console applications. ## Supported .NET versions ServiceComposer targets .NET 8. -## Note about thread safety - -If resources are shared across more than one handler they must be [thread-safe](thread-safety.md). +> [!NOTE] +> About thread safety +> If resources are shared across more than one handler they must be [thread-safe](thread-safety.md). ## Upgrade guides From aa5da40963bb7c1f9b07357a230b47e9c017eda8 Mon Sep 17 00:00:00 2001 From: Mauro Servienti Date: Fri, 1 Nov 2024 18:14:01 +0100 Subject: [PATCH 2/2] getting started skeleton --- docs/README.md | 6 ++++-- docs/getting-started.md | 9 +++++++++ 2 files changed, 13 insertions(+), 2 deletions(-) create mode 100644 docs/getting-started.md diff --git a/docs/README.md b/docs/README.md index 21cb3fc8..411c479e 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,8 +1,10 @@ # Documentation -## Hosting +The [getting started](getting-started.md) documentation provides an overview of the basic building blocks: -ServiceComposer leverages the ASP.NET Core Endpoints support to plugin into the request handling pipeline. ServiceComposer can be added to existing or new ASP.NET Core projects, or it can be hosted standalone in .NET console applications. +- [Hosting](getting-started.md) +- [Composition requests handlers](getting-started.md#composition-requests-handlers) +- [Composition events handlers](getting-started.md#composition-events-handlers) ## Supported .NET versions diff --git a/docs/getting-started.md b/docs/getting-started.md new file mode 100644 index 00000000..c5e33e0f --- /dev/null +++ b/docs/getting-started.md @@ -0,0 +1,9 @@ +# Getting started + +## Hosting + +ServiceComposer leverages the ASP.NET Core Endpoints support to plugin into the request handling pipeline. ServiceComposer can be added to existing or new ASP.NET Core projects, or it can be hosted standalone in .NET console applications. + +## Composition requests handlers + +## Composition events handlers