docs: add two hands-on tutorials (Data Inspector + A11y Inspector) - #290
Open
antfubot wants to merge 4 commits into
Open
docs: add two hands-on tutorials (Data Inspector + A11y Inspector)#290antfubot wants to merge 4 commits into
antfubot wants to merge 4 commits into
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub. |
Adds a step-by-step, human-oriented guide that builds a simplified data-inspector devframe from zero to an MVP (client + RPC over a Vite bridge), then layers on a hub dock, static build, standalone server, and CLI — one concept per step. Slots in as guide page 1 (after the intro); drops the earlier Project Structure page per review.
…messages Adds 'An Inspector That Talks to the Page' as guide page 2: a self-contained, vanilla-TS walkthrough building an accessibility inspector whose in-page agent (a dock client script) scans the host page, coordinates with the panel iframe over a same-origin BroadcastChannel, and reports scans to the hub messages feed via ctx.messages. Renumbers the reference pages down by one.
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
1 participant
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.
What
Adds two hands-on, from-zero tutorials to the top of the guide, so newcomers get a build-along path before the reference pages.
1. Tutorial: Build a Data Inspector (
/guide/tutorial)Builds a devtool from an empty folder, then grows it one capability at a time — each step one new concept:
defineDevframe+ctx.rpc.register→ a client viaconnectDevframe()→ run it withdevframeViteBridge→ a hub dock (clientAssets+viteDevframeHub) → a static build (snapshot+createBuild) → a standalone server (createDevServer) → a CLI (createCac).2. Tutorial: An Inspector That Talks to the Page (
/guide/tutorial-a11y)A second, self-contained walkthrough focused on host ↔ devtools-client communication and the messages API. Builds a small accessibility inspector whose in-page agent (a dock client script) scans the host page, coordinates with the panel iframe over a same-origin
BroadcastChannel, and reports each scan to the hub's messages feed viactx.messages. Distilled fromexamples/a11y-messages-playgroundand@devframes/plugin-a11y.Placement
Flow is now: Introduction → Data Inspector → A11y Inspector → Devframe Definition → RPC → … The reference pages are renumbered accordingly (git-tracked renames; links use path names, so nothing breaks), and the intro's "What's next" links to both.
Notes
createDevframeClientHost, theDockClientScriptContextmessages client,createBuild/createDevServer/createCac).This PR was created with the help of an agent.