docs: add the write-your-first-plugin walkthrough - #260
Merged
Conversation
The policy pages say what a plugin may do and the generated reference lists every hook, but nothing walked an author from an empty directory to a plugin running inside a board. This is that path: scaffold, change a hook, test it, install it into a board, publish it, and submit it to the marketplace. Registered in the docs manifest and linked from the index, so the site publishes it alongside the policy pages. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01G22SRRgkUV7doefmw9NMNf
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
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.
Part of MEI-115 (deliverable 3 of 4: the authoring journey). Follows #258 (scaffolds) and #259 (smoke).
What this adds
docs/customization/first-plugin.md— the tutorial-shaped page the ticket asks for, taking an author from an empty directory to a listed plugin:scaffold → change a hook → test it → install it into a board → publish → submit to the marketplace.
The existing customization pages are policy and reference:
plugins.mdsays what a plugin may and may not do, andplugin-hooks.mdlists every hook. Neither shows the path through them, which is the blank page a third-party author actually faces. This page assumes both exist and links out rather than restating them.Registered in
apps/web/content/docs.manifest.jsonand linked fromdocs/README.md(both the task table and the customization list);pnpm site:docsregenerated the root README table.Two details worth flagging for review:
Validated
pnpm site:docs:check,pnpm docs:index:checkandpnpm docs:links:checkall pass (43 documents, 733 headings, every internal link and anchor resolves).🤖 Generated with Claude Code
https://claude.ai/code/session_01G22SRRgkUV7doefmw9NMNf
Generated by Claude Code