Skip to content

Commit a3c2221

Browse files
committed
docs: add preview images to each module readme
1 parent 4b5e905 commit a3c2221

10 files changed

Lines changed: 143 additions & 1 deletion

File tree

01-quickstart/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
Pull a model, run a one-shot prompt and discover the OpenAI-compatible API endpoint, all in a single script.
44

5+
![Quickstart script output](../assets/01-quickstart.svg)
6+
57
## Prerequisites
68

79
- Docker Desktop 4.40+ with Docker Model Runner enabled

02-openai-api/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ Docker Model Runner exposes an OpenAI-compatible API, so any OpenAI client or pl
77

88
No API key is required, but OpenAI client libraries usually expect a non-empty one, so pass any placeholder value.
99

10+
![curl examples output, non-streaming and streaming](../assets/02-openai-api.svg)
11+
1012
## curl
1113

1214
```bash

03-dotnet-chat/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ Docker Model Runner, using the official [`OpenAI`](https://www.nuget.org/package
55

66
Because DMR is OpenAI-compatible, the only DMR-specific detail is the base URL.
77

8+
![.NET streaming chat session](../assets/03-dotnet-chat.svg)
9+
810
## Prerequisites
911

1012
- .NET 10 SDK

04-compose/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
Provision the model and a small app together with a single `docker compose up`.
44

5+
![docker compose up and a POST /chat response](../assets/04-compose.svg)
6+
57
The [`compose.yaml`](compose.yaml) uses the top-level `models` element so Compose makes
68
`ai/gemma3` available through Docker Model Runner, and binds it to the `chat-api` service
79
using the long syntax. Compose injects two environment variables into the container:

05-blazor-chat/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ The OpenAI SDK runs server-side (the same pattern as [03-dotnet-chat](../03-dotn
66
[04-compose](../04-compose)), and the model streams its answer token by token to the browser over
77
the Blazor SignalR connection. No CORS setup, no API key, no data leaving your machine.
88

9-
<!-- ![Blazor chat screenshot](../assets/blazor-chat.png) -->
9+
![Blazor chat UI](../assets/05-blazor-chat.svg)
1010

1111
## Features
1212

assets/01-quickstart.svg

Lines changed: 23 additions & 0 deletions
Loading

assets/02-openai-api.svg

Lines changed: 24 additions & 0 deletions
Loading

assets/03-dotnet-chat.svg

Lines changed: 18 additions & 0 deletions
Loading

assets/04-compose.svg

Lines changed: 20 additions & 0 deletions
Loading

assets/05-blazor-chat.svg

Lines changed: 49 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)