docs(examples): update READMEs for all examples

ericgregory · claude · ricochet · commit bddfd0956d96 · 2026-04-03T23:03:07.000+02:00
Co-Authored-By: Claude Sonnet 4.6 &lt;noreply@anthropic.com&gt;
Signed-off-by: Eric Gregory &lt;eric@cosmonic.com&gt;
diff --git a/examples/components/bundled-esbuild/README.md b/examples/components/bundled-esbuild/README.md
@@ -1,10 +1,10 @@
 # Typescript component bundled with esbuild
 
-This repository contains a custom wasm component, written in [Typescript][ts].
+This repository contains a custom wasm component, written in [TypeScript][ts].
 
 This component:
 
-- Uses [Typescript][ts] for it's implementation
+- Uses [TypeScript][ts] for it's implementation
 - Bundles with [esbuild][esbuild]
 
 [ts]: https://www.typescriptlang.org/
@@ -23,11 +23,11 @@ Building this project relies on the following software:
 
 | Name   | Description                                                                                                 |
 | ------ | ----------------------------------------------------------------------------------------------------------- |
-| `wash` | [Wasmcloud Shell][wash] controls your [wasmcloud][wasmcloud] host instances and enables building components |
+| `wash` | [Wasm Shell][wash] controls your [wasmcloud][wasmcloud] host instances and enables building components |
 | `npm`  | [Node Package Manager (NPM)][npm] which manages packages for for the NodeJS ecosystem                       |
 | `node` | [NodeJS runtime][nodejs] (see `.nvmrc` for version)                                                         |
 
-[wash]: https://github.com/wasmCloud/wasmCloud/tree/main/crates/wash-cli
+[wash]: https://wasmcloud.com/docs/installation/#install-wash
 [node]: https://nodejs.org
 [npm]: https://github.com/npm/cli
 
@@ -49,7 +49,7 @@ The main entry point is the `start` script (i.e. `npm start`) which performs the
 
 - `npm install` to download all dependencies
 - building the component
-- transpiling the component so it can be called from javascript
+- transpiling the component so it can be called from JavaScript
 - running the demo.js script
 
 ## Bundling
diff --git a/examples/components/bundled-rsbuild/README.md b/examples/components/bundled-rsbuild/README.md
@@ -1,10 +1,10 @@
 # Typescript component bundled with rslib/rsbuild
 
-This repository contains a hello world HTTP component, written in [Typescript][ts].
+This repository contains a hello world HTTP component, written in [TypeScript][ts].
 
 This component:
 
-- Uses [Typescript][ts] for it's implementation
+- Uses [TypeScript][ts] for its implementation
 - Bundles with [rslib][rslib]
 
 [ts]: https://www.typescriptlang.org/
@@ -23,11 +23,11 @@ Building this project relies on the following software:
 
 | Name   | Description                                                                                                 |
 | ------ | ----------------------------------------------------------------------------------------------------------- |
-| `wash` | [Wasmcloud Shell][wash] controls your [wasmcloud][wasmcloud] host instances and enables building components |
+| `wash` | [Wasm Shell][wash] controls your [wasmCloud][wasmcloud] host instances and enables building components |
 | `npm`  | [Node Package Manager (NPM)][npm] which manages packages for for the NodeJS ecosystem                       |
 | `node` | [NodeJS runtime][nodejs] (see `.nvmrc` for version)                                                         |
 
-[wash]: https://github.com/wasmCloud/wasmCloud/tree/main/crates/wash-cli
+[wash]: https://wasmcloud.com/docs/installation/#install-wash
 [node]: https://nodejs.org
 [npm]: https://github.com/npm/cli
 
@@ -52,4 +52,4 @@ See package.json for the exact commands being run. But what `npm start` does is:
 
 ## Bundling
 
-It uses rslib to bundling the javascript together with the dependencies. See the [`rslib.config.rs`](https://github.com/wasmCloud/typescript/blob/main/examples/components/bundled-rsbuild/rslib.config.ts) file in the example folder for more details.
+It uses rslib to bundling the JavaScript together with the dependencies. See the [`rslib.config.rs`](https://github.com/wasmCloud/typescript/blob/main/examples/components/bundled-rsbuild/rslib.config.ts) file in the example folder for more details.
diff --git a/examples/components/http-axios/README.md b/examples/components/http-axios/README.md
@@ -1,4 +1,4 @@
-# Typescript Axios example CLI
+# TypeScript Axios example CLI
 
 This repository contains a WebAssembly Component written in [Typescript][ts], which:
 
@@ -12,8 +12,8 @@ the widely used HTTP request library `axios`.
 
 [axios]: https://www.npmjs.com/package/axios
 [ts]: https://www.typescriptlang.org/
-[wasi-cli]: clis://github.com/WebAssembly/wasi-cli
-[wasmcloud]: https://wasmcloud.com/docs/intro
+[wasi-cli]: https://wasmcloud.com/docs/installation/#install-wash
+[wasmcloud]: https://wasmcloud.com/docs/
 [wasmtime]: https://wasmtime.dev
 [jco]: https://github.com/bytecodealliance/jco
 
@@ -35,7 +35,7 @@ Building this project relies on the following installed software:
 | `node` | [NodeJS runtime][nodejs] (see `.nvmrc` for version)                                                         |
 | `wkg`  | (optional) [wasm-pkg-tools][wasm-pkg-tools] project that makes it easy to pull down WIT definitions         |
 
-[wash]: https://github.com/wasmCloud/wasmCloud/tree/main/crates/wash-cli
+[wash]: https://wasmcloud.com/docs/installation/#install-wash
 [node]: https://nodejs.org
 [npm]: https://github.com/npm/cli
 [wasm-pkg-tools]: https://github.com/bytecodealliance/wasm-pkg-tools
@@ -55,20 +55,14 @@ To get into a rapid development loop, clone the repo and run `wash dev`:
 ```console
 wash dev
 ```
-
 `wash dev` does many things for you:
 
 - Starts the [wasmCloud host][wasmcloud-host] that can run your WebAssembly component
 - Builds this project (including necessary `npm` script targets)
-- Builds a declarative WADM manifest consisting of:
-  - Your locally built component
-  - A [HTTP server provider][http-client-provider] which will peform outgoing requests on your component's behalf
-  - Necessary links between providers and your component so your component can make requests
-- Deploys the built manifest (i.e all dependencies to run this application) locally
-- Watches your code for changes and re-deploys when necessary.
+- Deploys an HTTP server on port 8000 and links it to your component
+- Watches your code for changes and re-deploys when necessary
 
-[wasmcloud-host]: https://wasmcloud.com/docs/concepts/hosts
-[httpclient-provider]: https://github.com/wasmCloud/wasmCloud/tree/main/crates/providers-http-client
+[wasmcloud-host]: https://wasmcloud.com/docs/overview/hosts
 
 ## With `jco`
 
@@ -141,4 +135,4 @@ wash call wasmcloud:examples/invoke.call
 
 ## Adding Capabilities
 
-To learn how to extend this example with additional capabilities, see the [Adding Capabilities](https://wasmcloud.com/docs/tour/adding-capabilities?lang=typescript) section of the wasmCloud documentation.
+To learn how to extend this example with additional capabilities, see the [TypeScript Language Guide](https://wasmcloud.com/docs/wash/developer-guide/language-support/typescript/) in the wasmCloud documentation.
diff --git a/examples/components/http-hello-world/README.md b/examples/components/http-hello-world/README.md
@@ -28,13 +28,13 @@ Building this project relies on the following software:
 | `npm`  | [Node Package Manager (NPM)][npm] manages packages for the NodeJS ecosystem |
 | `node` | [NodeJS runtime][nodejs] (see `.nvmrc` for version)                         |
 
-[wash]: https://github.com/wasmCloud/wash
+[wash]: https://wasmcloud.com/docs/installation/#install-wash
 [node]: https://nodejs.org
 [npm]: https://github.com/npm/cli
 
 # Quickstart
 
-To get started developing this repository quickly, clone the repo and run `wash dev`:
+To get started developing this project quickly, clone the repo and run `wash dev` in this directory:
 
 ```console
 wash dev
@@ -56,4 +56,4 @@ curl localhost:8000
 
 ## Adding Capabilities
 
-To learn how to extend this example with additional capabilities, see the [Adding Capabilities](https://wasmcloud.com/docs/tour/adding-capabilities?lang=typescript) section of the wasmCloud documentation.
+To learn how to extend this example with additional capabilities, see the [TypeScript Language Guide](https://wasmcloud.com/docs/wash/developer-guide/language-support/typescript/) in the wasmCloud documentation.
diff --git a/examples/components/http-password-checker/README.md b/examples/components/http-password-checker/README.md
@@ -1,6 +1,6 @@
 # Typescript HTTP Password Checker
 
-This repository contains a WebAssembly Component written in [Typescript][ts], which:
+This repository contains a WebAssembly Component written in [TypeScript][ts], which:
 
 - Implements a [`wasi:http`][wasi-http]-compliant HTTP handler
 - Provides an API for checking password strength
@@ -13,7 +13,7 @@ This example also demonstrates using JS ecosystem packages in a Wasm component,
 
 [ts]: https://www.typescriptlang.org/
 [wasi-http]: https://github.com/WebAssembly/wasi-http
-[wasmcloud]: https://wasmcloud.com/docs/intro
+[wasmcloud]: https://wasmcloud.com/docs/
 [zod]: https://github.com/colinhacks/zod
 [valibot]: https://github.com/fabian-hiller/valibot
 [npm-check-password-strength]: https://www.npmjs.com/package/check-password-strength
@@ -31,11 +31,11 @@ Building this project relies on the following installed software:
 
 | Name   | Description                                                                                          |
 | ------ | ---------------------------------------------------------------------------------------------------- |
-| `wash` | [Wasmcloud Shell][wash] controls your [wasmcloud][wasmcloud] host instances and enables building components (version >= 2.0) |
+| `wash` | [Wasm Shell][wash] controls your [wasmCloud][wasmcloud] host instances and enables building components (version >= 2.0) |
 | `npm`  | [Node Package Manager (NPM)][npm] which manages packages for the NodeJS ecosystem                    |
 | `node` | [NodeJS runtime][nodejs] (see `.nvmrc` for version)                                                  |
 
-[wash]: https://github.com/wasmCloud/wasmCloud/tree/main/crates/wash-cli
+[wash]: https://wasmcloud.com/docs/installation/#install-wash
 [node]: https://nodejs.org
 [npm]: https://github.com/npm/cli
 
@@ -54,7 +54,7 @@ wash dev
 - Deploys an HTTP server on port 8000 and links it to your component
 - Watches your code for changes and re-deploys when necessary
 
-[wasmcloud-host]: https://wasmcloud.com/docs/concepts/hosts
+[wasmcloud-host]: https://wasmcloud.com/docs/overview/hosts/
 
 ## Send a request to the running component
 
@@ -79,7 +79,7 @@ You should see a JSON response like:
 
 ## Adding Capabilities
 
-To learn how to extend this example with additional capabilities, see the [Adding Capabilities](https://wasmcloud.com/docs/tour/adding-capabilities?lang=typescript) section of the wasmCloud documentation.
+To learn how to extend this example with additional capabilities, see the [TypeScript Language Guide](https://wasmcloud.com/docs/wash/developer-guide/language-support/typescript/) in the wasmCloud documentation.
 
 # Issues / FAQ
 
diff --git a/examples/components/http-streaming/README.md b/examples/components/http-streaming/README.md
@@ -1,6 +1,6 @@
 # Typescript HTTP Streaming
 
-This repository contains an HTTP component that performs a streaming response using WASI I/O and HTTP primitives, written in [Typescript][ts].
+This repository contains an HTTP component that performs a streaming response using WASI I/O and HTTP primitives, written in [TypeScript][ts].
 
 This component:
 
@@ -25,11 +25,11 @@ Building this project relies on the following software:
 
 | Name   | Description                                                                                                                        |
 | ------ | ---------------------------------------------------------------------------------------------------------------------------------- |
-| `wash` | [Wasmcloud Shell][wash] controls your [wasmcloud][wasmcloud] host instances and enables building components (version >= 2.0)       |
+| `wash` | [Wasm Shell][wash] controls your [wasmCloud][wasmcloud] host instances and enables building components (version >= 2.0)       |
 | `npm`  | [Node Package Manager (NPM)][npm] which manages packages for the NodeJS ecosystem                                                  |
 | `node` | [NodeJS runtime][nodejs] (see `.nvmrc` for version)                                                                                |
 
-[wash]: https://github.com/wasmCloud/wasmCloud/tree/main/crates/wash-cli
+[wash]: https://wasmcloud.com/docs/installation/#install-wash
 [node]: https://nodejs.org
 [npm]: https://github.com/npm/cli
 
@@ -48,7 +48,7 @@ wash dev
 - Deploys an HTTP server on port 8000 and links it to your component
 - Watches your code for changes and re-deploys when necessary
 
-[wasmcloud-host]: https://wasmcloud.com/docs/concepts/hosts
+[wasmcloud-host]: https://wasmcloud.com/docs/overview/hosts
 
 ## Send a request to the running component
 
@@ -60,4 +60,4 @@ curl localhost:8000
 
 ## Adding Capabilities
 
-To learn how to extend this example with additional capabilities, see the [Adding Capabilities](https://wasmcloud.com/docs/tour/adding-capabilities?lang=typescript) section of the wasmCloud documentation.
+To learn how to extend this example with additional capabilities, see the [TypeScript Language Guide](https://wasmcloud.com/docs/wash/developer-guide/language-support/typescript/) in the wasmCloud documentation.
