docs: regulate the terminology with a canonical Terms page - #298
Merged
Conversation
…guide One name per concept: a new guide-leading Terms page fixes the vocabulary (a devframe, built-in devframe, host framework, host page, user app, node side / browser side, client runtime, page script, in-page channel, viewer, dock entry/rail/panel, storage scopes), AGENTS.md gains the matching regulation, and the guide pages shift up one number to lead with it. Stale numbered-path comments in code follow the renumber.
…ent" The injected half is now the page script, talking to the panel over the in-page channel, so "agent" stays reserved for coding agents. Internal types, the wire message (a11y:page-script-ready), and UI copy follow; the public export a11yAgentBundlePath keeps its name.
Every docs page (error pages included) and README now follows the Terms page: built-in devframes instead of a plugin concept, host framework / host page / user app, node side / browser side, client runtime, RPC client, viewer over shell, dock rail/panel, page script and in-page channel, qualified scopes and sessions.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
antfu
reviewed
Aug 26, 2026
…sageChannel
Adopts antfu's review on the Terms page: the hub UI implementation term
becomes "hub UI provider" repo-wide ("external viewer" survives for
cross-origin surfaces and gains its own terms row), the mount-context
row reads "hosted / standalone adapters", and the in-page channel lists
MessageChannel alongside BroadcastChannel. Diagnostic fix strings and
code comments follow; API names (initHub's ui.viewer slot,
registerDevframeViewerOrigin) are unchanged.
createDevframeClientHost \u2192 createDevframeClientRuntime (with the DevframeClientRuntime/Options types) so the API says what every docs page now says; a11yAgentBundlePath \u2192 a11yPageScriptBundlePath; the data-inspector inject exports drop "agent" (DISCOVERY_FILE / InjectDiscovery / DataInspectorEndpoint, discovery file now discovery.json with attach falling back to the old agent.json). Old names stay as @deprecated aliases; kits re-export both; snapshots, docs anchors, examples, and the devframe skill follow.
Collaborator
Author
|
Follow-up from the API/terms audit (c425f80): audited every public export across the 20+ packages against the Terms page — only three clusters genuinely clashed, now renamed with silent
Everything else keeps its name deliberately: |
…ences section New docs/content/8.references/ section (own Reference nav tab, flat sidebar): the Terms page, When Clauses, and the Events Reference move out of the guide, which renumbers to close the gaps. Old /guide/* URLs redirect via vercel.json; guide sidebar groups keep cross-section links to the moved pages; AGENTS.md and the events-map lockstep comments follow the new paths.
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.
What
The docs reused web-generic words — client, host, server, agent, plugin — in up to six senses each (
client hostvshost pagebeing the worst pair). This PR fixes one name per concept and applies it everywhere.docs/content/1.guide/1.terms.md), leading the guide: area-grouped tables (core / node side / browser side / hub) plus a communication-paths table contrasting RPC (browser ↔ node), the client context (client scripts ↔ client runtime), and the in-page channel (page script ↔ panel). Guide pages renumbered to make room; URLs are number-stripped so links are unaffected.client/host/server/agent/plugin/embedded/standalonenever appear unqualified in prose (one exception: directionalclient → serverarrows in the RPC/events tables).@devframes/plugin-*packages are built-in devframes; theplugin-npm prefix only sets them apart from core packages./plugins/…URLs and RPC ids keep their literal names; the docs section is retitled Built-in Devframes.createDevframeClientHost()runtime in prose; node side / browser side name a devframe's halves; viewer replaces shell; dock rail/panel/entry; storage scopes are never described as "per-workspace".a11y:page-script-readywire message, and UI copy renamed; the public exporta11yAgentBundlePathkeeps its name — zero public API changes).Why
One name per concept makes the docs learnable and gives future edits (human or agent) a rule to follow instead of drifting back into ambiguity.
pnpm lint && pnpm knip && pnpm test && pnpm typecheck && pnpm buildall pass (116 test files, 1271 tests).Created with the help of an agent.