Skip to content

Commit 032982f

Browse files
committed
refactor(documentation): update
1 parent c3b301a commit 032982f

16 files changed

Lines changed: 512 additions & 13 deletions

documentation/simplew/docs/.vitepress/config.mjs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,7 @@ export default defineConfig({
117117
text: 'Services',
118118
items: [
119119
{ text: 'BasicAuth', link: '/addons/service-basicauth' },
120+
{ text: 'Background', link: '/addons/service-background' },
120121
{ text: 'Chaos', link: '/addons/service-chaos' },
121122
{ text: 'Firewall', link: '/addons/service-firewall' },
122123
{ text: 'Jwt', link: '/addons/service-jwt' },

documentation/simplew/docs/addons/helper-basicauth.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ The helper package does not provide a handler metadata attribute.
6868
In a helper-only integration, you define your own `BasicAuthAttribute` in the application.
6969

7070

71-
## Minimal Example
71+
## Minimal example
7272

7373
This example shows the intended architecture:
7474
- a `BasicAuthHelper` handles the Basic auth protocol

documentation/simplew/docs/addons/helper-hosting.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ $ dotnet add package SimpleW.Helper.Hosting --version 26.0.0
3939
```
4040

4141

42-
## Minimal Example
42+
## Minimal example
4343

4444
```csharp
4545
using Microsoft.Extensions.Hosting;

documentation/simplew/docs/addons/helper-jwt.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ $ dotnet add package SimpleW.Helper.Jwt --version 26.0.0
7878
| `Scheme` | Authorization scheme used by the helper. |
7979

8080

81-
## Minimal Example
81+
## Minimal example
8282

8383
This example shows the intended architecture:
8484
- a `JwtBearerHelper` handles JWT creation and validation

documentation/simplew/docs/addons/helper-log4net.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ $ dotnet add package SimpleW.Helper.Log4net --version 26.0.0
4545
| Enricher | `null` | Optional callback allowing custom enrichment of the log4net properties for each log entry. Receives `(IDictionary<string, object?> properties, LogEntry entry)`. |
4646

4747

48-
## Minimal Example
48+
## Minimal example
4949

5050
Configure a simple log4net console logger in code :
5151

documentation/simplew/docs/addons/helper-openid.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ Already authenticated users survive a server restart while the provider `id_toke
126126
| `Principal` | Authenticated principal when `IsSuccess` is `true`. |
127127

128128

129-
## Minimal Example
129+
## Minimal example
130130

131131
This example shows the intended architecture:
132132
- an `OpenIDHelper` handles the OpenID Connect protocol

documentation/simplew/docs/addons/helper-razor.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ $ dotnet add package SimpleW.Helper.Razor --version 26.0.0
4949
| OnAfterRender | `null` | Optional hook executed after rendering a Razor view. Useful for logging, metrics, or post-processing the output. |
5050

5151

52-
## Minimal Example
52+
## Minimal example
5353

5454
### 1. Folder Structure
5555

documentation/simplew/docs/addons/helper-serilog.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ $ dotnet add package SimpleW.Helper.Serilog --version 26.0.0
4646
| Enricher | `null` | Optional function allowing custom enrichment of the Serilog logger per log entry. Receives `(ILogger logger, LogEntry entry)` and must return the enriched `ILogger`. |
4747

4848

49-
## Minimal Example
49+
## Minimal example
5050

5151
Create your Serilog logger normally :
5252

documentation/simplew/docs/addons/helper-swagger.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ $ dotnet add package SimpleW.Helper.Swagger --version 26.0.0
4949
| UiHtmlFactory | `null` | Optional factory to fully customize the Swagger UI HTML page. Receives the generated OpenAPI JSON string and must return the final HTML. If `null`, the built-in Swagger UI template is used. |
5050

5151

52-
## Minimal Example
52+
## Minimal example
5353

5454
```csharp
5555
using System.Net;

0 commit comments

Comments
 (0)