docs: link static plugin implementation as plugin API example - #642
Open
Ethan-Arrowood wants to merge 2 commits into
Open
docs: link static plugin implementation as plugin API example#642Ethan-Arrowood wants to merge 2 commits into
Ethan-Arrowood wants to merge 2 commits into
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Code Review
This pull request updates the documentation in plugin-api.md and overview.md to include links to the open-source implementation of the built-in static plugin. The feedback suggests hyphenating 'open-source' when it is used as a compound modifier preceding a noun.
| ## 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). |
Contributor
There was a problem hiding this comment.
Use a hyphen for "open-source" when it functions as a compound modifier preceding the noun "implementation".
Suggested change
| 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). |
🚀 Preview DeploymentYour preview deployment is ready! 🔗 Preview URL: https://preview.harper-documentation.harperfabric.com/pr-642 This preview will update automatically when you push new commits. |
dawsontoth
approved these changes
Aug 27, 2026
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 <noreply@anthropic.com>
Review feedback on #642: "open source implementation" uses a compound modifier before a noun, which takes a hyphen. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Ethan-Arrowood
force-pushed
the
docs/static-plugin-source-link
branch
from
August 27, 2026 21:40
6b1cf76 to
e4d100b
Compare
🚀 Preview DeploymentYour preview deployment is ready! 🔗 Preview URL: https://preview.harper-documentation.harperfabric.com/pr-642 This preview will update automatically when you push new commits. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The static file plugin is now open source, and its implementation is a good worked example of the modern Plugin API. This adds a cross-reference to it from the two pages a reader would land on.
Changes
reference/static-files/overview.md- one sentence after the intro pointing atserver/static.tsas the source of truth for the documented behavior.reference/components/plugin-api.md- extends the existing "Example: Static File Server Plugin" lead-in to point from the simplified snippet at the complete production implementation.No restructuring on either page; both edits are a single sentence plus a link.
Verification
npm run format:checkcleannpm run buildsucceeds (exit 0)Note: the build emits two broken-anchor warnings (
/reference/v5/backups/overviewand/release-notes/v5-lincoln/5.1). Both are pre-existing onmainand unrelated to these files.Closes #375
🤖 Generated with Claude Code