List example projects in documentation

Author: bkoelman

docs/request-examples/README.md

@@ -2,18 +2,20 @@
 
 To update these requests:
 
-1. Add a PowerShell (.ps1) script prefixed by a number that is used to determine the order the scripts are executed. The script should execute a request and output the response. Example:
-```
-curl -s http://localhost:14141/api/books
-```
+1. Add a PowerShell (`.ps1`) script prefixed by a number that is used to determine the order the scripts are executed.
+  The script should execute a request and output the response. For example:
+   ```
+   curl -s http://localhost:14141/api/books
+   ```
 
-2. Add the example to `index.md`. Example:
-```
-### Get with relationship
+2. Add the example to `index.md`. For example:
+   ```
+   ### Get with relationship
 
-[!code-ps[REQUEST](003_GET_Books-including-Author.ps1)]
-[!code-json[RESPONSE](003_GET_Books-including-Author_Response.json)]
-```
+   [!code-ps[REQUEST](003_GET_Books-including-Author.ps1)]
+   [!code-json[RESPONSE](003_GET_Books-including-Author_Response.json)]
+   ```
 
-3. Run `pwsh ../generate-examples.ps1`
-4. Verify the results by running `pwsh ../build-dev.ps1`
+3. Run `pwsh ../generate-examples.ps1` to execute the request.
+
+4. Run `pwsh ../build-dev.ps1` to view the output on the website.

docs/request-examples/index.md

@@ -1,17 +1,27 @@
----
-_disableToc: true
----
+# Example projects
 
-# Example requests
+Runnable example projects can be found [here](https://github.com/json-api-dotnet/JsonApiDotNetCore/tree/master/src/Examples):
+
+- GettingStarted: A simple project with minimal configuration to have a runnable project in minutes.
+- JsonApiDotNetCoreExample: Showcases commonly-used features, such as resource definitions, atomic operations, and OpenAPI.
+  - OpenApiNSwagClientExample: Uses [NSwag](https://github.com/RicoSuter/NSwag) to generate a typed OpenAPI client.
+  - OpenApiKiotaClientExample: Uses [Kiota](https://learn.microsoft.com/en-us/openapi/kiota/) to generate a typed OpenAPI client.
+- MultiDbContextExample: Shows how to use multiple `DbContext` classes, for connecting to multiple databases.
+- DatabasePerTenantExample: Uses a different database per tenant. See [here](https://github.com/json-api-dotnet/JsonApiDotNetCore/tree/master/test/JsonApiDotNetCoreTests/IntegrationTests/MultiTenancy) for using multiple tenants in the same database.
+- NoEntityFrameworkExample: Uses a read-only in-memory repository instead of a real database.
+- DapperExample: Uses [Dapper](https://github.com/DapperLib/Dapper) to execute SQL queries.
+- ReportsExample: Uses a resource service that returns aggregated data.
 
-These requests have been generated against the "GettingStarted" application and are updated on every deployment.
+Additional use cases are provided as integration tests [here](https://github.com/json-api-dotnet/JsonApiDotNetCore/tree/master/test/JsonApiDotNetCoreTests/IntegrationTests).
+
+# Example requests
 
-All of these requests have been created using out-of-the-box features.
+The following requests are automatically generated against the "GettingStarted" application on every deployment.
 
 > [!NOTE]
 > curl requires "[" and "]" in URLs to be escaped.
 
-# Reading data
+## Reading data
 
 ### Get all
 
@@ -48,7 +58,7 @@ All of these requests have been created using out-of-the-box features.
 [!code-ps[REQUEST](007_GET_Books-paginated.ps1)]
 [!code-json[RESPONSE](007_GET_Books-paginated_Response.json)]
 
-# Writing data
+## Writing data
 
 ### Create resource