From 9e7e1b0900b929d627d4642f954a6ba348ea46b7 Mon Sep 17 00:00:00 2001 From: Ethan Arrowood Date: Thu, 27 Aug 2026 14:33:43 -0600 Subject: [PATCH 1/2] docs: link static plugin implementation as plugin API example The static file plugin is now open source. Link its implementation from the Static Files overview (source of truth for behavior) and from the Plugin API page (real-world example of the modern plugin API). Co-Authored-By: Claude Opus 5 --- reference/components/plugin-api.md | 2 +- reference/static-files/overview.md | 2 ++ 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/reference/components/plugin-api.md b/reference/components/plugin-api.md index 43211396f..afa4650bf 100644 --- a/reference/components/plugin-api.md +++ b/reference/components/plugin-api.md @@ -381,7 +381,7 @@ Function signature for the `'all'` event handler passed to `scope.handleEntry()` ## Example: Static File Server Plugin -A simplified form of the built-in `static` plugin demonstrating key Plugin API patterns: +A simplified form of the built-in `static` plugin demonstrating key Plugin API patterns. For a complete, production example of this API in action, read the plugin's open source implementation in [`server/static.ts`](https://github.com/HarperFast/harper/blob/main/server/static.ts). ```js export function handleApplication(scope) { diff --git a/reference/static-files/overview.md b/reference/static-files/overview.md index 49a10672b..f2b9355b0 100644 --- a/reference/static-files/overview.md +++ b/reference/static-files/overview.md @@ -19,6 +19,8 @@ The `static` built-in plugin serves static files from your Harper application ov `static` does **not** need to be installed — it is built into Harper and only needs to be declared in your `config.yaml`. +The plugin is open source: its implementation in [`server/static.ts`](https://github.com/HarperFast/harper/blob/main/server/static.ts) is the source of truth for the behavior described on this page. + ## Basic Usage Configure `static` with the `files` option pointing to the files you want to serve: From e4d100be3b64d27a5bfac23b142f1de2cfbec4b8 Mon Sep 17 00:00:00 2001 From: Ethan Arrowood Date: Thu, 27 Aug 2026 15:39:40 -0600 Subject: [PATCH 2/2] docs: hyphenate "open-source" compound modifier Review feedback on #642: "open source implementation" uses a compound modifier before a noun, which takes a hyphen. Co-Authored-By: Claude Opus 5 --- reference/components/plugin-api.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/reference/components/plugin-api.md b/reference/components/plugin-api.md index afa4650bf..3d26a67af 100644 --- a/reference/components/plugin-api.md +++ b/reference/components/plugin-api.md @@ -381,7 +381,7 @@ Function signature for the `'all'` event handler passed to `scope.handleEntry()` ## Example: Static File Server Plugin -A simplified form of the built-in `static` plugin demonstrating key Plugin API patterns. For a complete, production example of this API in action, read the plugin's open source implementation in [`server/static.ts`](https://github.com/HarperFast/harper/blob/main/server/static.ts). +A simplified form of the built-in `static` plugin demonstrating key Plugin API patterns. For a complete, production example of this API in action, read the plugin's open-source implementation in [`server/static.ts`](https://github.com/HarperFast/harper/blob/main/server/static.ts). ```js export function handleApplication(scope) {