Skip to content

Getting started documentation #747

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
mauroservienti wants to merge 2 commits into
base: master
Choose a base branch
from
Draft

Getting started documentation #747

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f1b525a
Refactor the docs README
mauroservienti Nov 1, 2024
aa5da40
getting started skeleton
mauroservienti Nov 1, 2024
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
15 changes: 9 additions & 6 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,18 @@
# 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.
The [getting started](getting-started.md) documentation provides an overview of the basic building blocks:

- [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

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

Expand Down
9 changes: 9 additions & 0 deletions docs/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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