Release 0.4.0

Author: kubinio123

docs/client/quickstart.md

@@ -5,7 +5,7 @@ Chimp ships an MCP client that connects to any MCP-compliant server. The client
 Add the dependency to your `build.sbt`:
 
 ```scala
-libraryDependencies += "com.softwaremill.chimp" %% "chimp-client" % "0.3.0"
+libraryDependencies += "com.softwaremill.chimp" %% "chimp-client" % "0.4.0"
 ```
 
 ## Example: the simplest MCP client
@@ -37,11 +37,11 @@ object QuickstartClient:
 For streaming transports, also add the dependency for your effect system — ZIO:
 
 ```scala
-libraryDependencies += "com.softwaremill.chimp" %% "chimp-client-zio" % "0.3.0"
+libraryDependencies += "com.softwaremill.chimp" %% "chimp-client-zio" % "0.4.0"
 ```
 
 or direct-style Ox:
 
 ```scala
-libraryDependencies += "com.softwaremill.chimp" %% "chimp-client-ox" % "0.3.0"
+libraryDependencies += "com.softwaremill.chimp" %% "chimp-client-ox" % "0.4.0"
 ```

docs/server/quickstart.md

@@ -5,15 +5,15 @@ Chimp lets you expose MCP tools over a JSON-RPC HTTP API. Tool inputs are descri
 Add the dependency to your `build.sbt`:
 
 ```scala
-libraryDependencies += "com.softwaremill.chimp" %% "chimp-server" % "0.3.0"
+libraryDependencies += "com.softwaremill.chimp" %% "chimp-server" % "0.4.0"
 ```
 
 ## Example: the simplest MCP server
 
 Below is a self-contained, [scala-cli](https://scala-cli.virtuslab.org)-runnable example:
 
 ```scala
-//> using dep com.softwaremill.chimp::chimp-server:0.3.0
+//> using dep com.softwaremill.chimp::chimp-server:0.4.0
 
 import chimp.*
 import sttp.tapir.*
@@ -39,13 +39,13 @@ case class AdderInput(a: Int, b: Int) derives io.circe.Codec, Schema
 For a streaming server that pushes progress and log notifications over SSE, add the dependency for your effect system — ZIO:
 
 ```scala
-libraryDependencies += "com.softwaremill.chimp" %% "chimp-server-zio" % "0.3.0"
+libraryDependencies += "com.softwaremill.chimp" %% "chimp-server-zio" % "0.4.0"
 ```
 
 or direct-style Ox:
 
 ```scala
-libraryDependencies += "com.softwaremill.chimp" %% "chimp-server-ox" % "0.3.0"
+libraryDependencies += "com.softwaremill.chimp" %% "chimp-server-ox" % "0.4.0"
 ```
 
 More runnable examples live in [`examples/`](https://github.com/softwaremill/chimp/tree/master/examples/src/main/scala/examples).

generated-docs/out/README.md

@@ -2,37 +2,23 @@
 
 Source for the chimp documentation site, built with Sphinx + MyST and hosted on Read the Docs.
 
-## Run locally
+## Setup
 
-From this folder:
+From this folder, once:
 
 ```
 python3 -m venv .venv
 source .venv/bin/activate
 pip install -r requirements.txt
-./watch.sh
 ```
 
-Open <http://127.0.0.1:8000>. Edits to `.md` files live-reload in the browser.
+## Making changes
 
-Next time, just:
-
-```
-source .venv/bin/activate
-./watch.sh
-```
-
-## Publishing changes
-
-Read the Docs builds from `generated-docs/out/`, **not** from this `docs/` folder. After editing the docs, regenerate that output with mdoc:
-
-```
-sbt compileDocs
-```
-
-Commit both `docs/` (the source) and `generated-docs/` (the mdoc output) — if `generated-docs/` is stale, the published site won't reflect your changes.
+1. **Update the docs** — edit the `.md` source files under `docs/`.
+2. **Build & watch to preview** — run `./watch.sh` (after `source .venv/bin/activate`) and open <http://127.0.0.1:8000>; edits live-reload in the browser.
+3. **Commit only `docs/`** — do **not** commit `generated-docs/`. Read the Docs builds from `generated-docs/out/`, but that mdoc output is regenerated and committed automatically as part of the release.
+4. **Verify** — run `sbt compileDocs` from the repo root to check that the Scala snippets in your docs compile.
 
 ## Notes
 
-- `0.3.0+50-cb889dff-SNAPSHOT` and other mdoc variables are **not** substituted in the local watch mode. For a fully-rendered preview, run `sbt docs/mdoc` from the repo root and serve `generated-docs/out/` instead.
-- Scala code snippets are verified by `sbt compileDocs` (also runs in CI).
+- `0.4.0` and other mdoc variables are **not** substituted in the local watch mode. For a fully-rendered preview, run `sbt docs/mdoc` from the repo root and serve `generated-docs/out/` (don't commit the result).

generated-docs/out/client/quickstart.md

@@ -5,7 +5,7 @@ Chimp ships an MCP client that connects to any MCP-compliant server. The client
 Add the dependency to your `build.sbt`:
 
 ```scala
-libraryDependencies += "com.softwaremill.chimp" %% "chimp-client" % "0.3.0"
+libraryDependencies += "com.softwaremill.chimp" %% "chimp-client" % "0.4.0"
 ```
 
 ## Example: the simplest MCP client
@@ -37,11 +37,11 @@ object QuickstartClient:
 For streaming transports, also add the dependency for your effect system — ZIO:
 
 ```scala
-libraryDependencies += "com.softwaremill.chimp" %% "chimp-client-zio" % "0.3.0"
+libraryDependencies += "com.softwaremill.chimp" %% "chimp-client-zio" % "0.4.0"
 ```
 
 or direct-style Ox:
 
 ```scala
-libraryDependencies += "com.softwaremill.chimp" %% "chimp-client-ox" % "0.3.0"
+libraryDependencies += "com.softwaremill.chimp" %% "chimp-client-ox" % "0.4.0"
 ```

generated-docs/out/server/quickstart.md

@@ -5,15 +5,15 @@ Chimp lets you expose MCP tools over a JSON-RPC HTTP API. Tool inputs are descri
 Add the dependency to your `build.sbt`:
 
 ```scala
-libraryDependencies += "com.softwaremill.chimp" %% "chimp-server" % "0.3.0"
+libraryDependencies += "com.softwaremill.chimp" %% "chimp-server" % "0.4.0"
 ```
 
 ## Example: the simplest MCP server
 
 Below is a self-contained, [scala-cli](https://scala-cli.virtuslab.org)-runnable example:
 
 ```scala
-//> using dep com.softwaremill.chimp::chimp-server:0.3.0
+//> using dep com.softwaremill.chimp::chimp-server:0.4.0
 
 import chimp.*
 import sttp.tapir.*
@@ -39,13 +39,13 @@ case class AdderInput(a: Int, b: Int) derives io.circe.Codec, Schema
 For a streaming server that pushes progress and log notifications over SSE, add the dependency for your effect system — ZIO:
 
 ```scala
-libraryDependencies += "com.softwaremill.chimp" %% "chimp-server-zio" % "0.3.0"
+libraryDependencies += "com.softwaremill.chimp" %% "chimp-server-zio" % "0.4.0"
 ```
 
 or direct-style Ox:
 
 ```scala
-libraryDependencies += "com.softwaremill.chimp" %% "chimp-server-ox" % "0.3.0"
+libraryDependencies += "com.softwaremill.chimp" %% "chimp-server-ox" % "0.4.0"
 ```
 
 More runnable examples live in [`examples/`](https://github.com/softwaremill/chimp/tree/master/examples/src/main/scala/examples).