Skip to content

docs: simplify kit docs and defer Devframe mechanics to devfra.me - #576

Closed
antfubot wants to merge 2 commits into
mainfrom
afraid-doodles-return
Closed

antfubot wants to merge 2 commits into
mainfrom
afraid-doodles-return

Conversation

@antfubot

Copy link
Copy Markdown
Collaborator

Description

Reworks the docs to stay focused on Vite DevTools specifics and lean on devfra.me for the framework-neutral Devframe mechanics.

  • Consolidated the kit/ section to the pages a Vite integration actually needs: the devtools.setup plugin hook, the dock system (with install launchers and the viteplus group), and the createPluginFromDevframe bridge. The introduction now frames Kit as the thin Vite skin over Devframe.
  • Deferred the generic mechanics to devfra.me — RPC, shared state, streaming, json-render, when clauses, terminals, messages, commands, and the remote client are all documented upstream, so those standalone pages were removed and now link out. Net ~4,000 lines deleted.
  • Kept the live remote-demo fixture (dogfooded by the core playground) and repointed its generic prose at the Devframe client guide.
  • Fixed a stale API reference on the DTK0033 error page (visibilityembeddedVisibility), the same removed option that website docs stale #562 flags.
  • Added a docs-build job to CI that mirrors the Netlify build command, so a broken docs build is caught in PRs instead of silently leaving the published site on a stale deploy — the most likely in-repo cause of the staleness reported in website docs stale #562.

Linked Issues

Fixes #562

Additional context

The website serves docs generated from this repo via Netlify (pnpm run build && pnpm run docs:build). The getting-started guide already used the corrected embeddedVisibility, so merging this (which touches docs) regenerates the site; the new CI job guards against future silent staleness. Verified locally with pnpm -C docs run docs:build (no dead links).

This PR was created with the help of an agent.

Refocus the docs on Vite DevTools specifics and consolidate the kit
section to the pages a Vite integration actually needs: the plugin hook,
the dock system, and the createPluginFromDevframe bridge. The generic
mechanics shared with every host framework (RPC, shared state, streaming,
json-render, when clauses, terminals, messages, commands, remote client)
now defer to the Devframe guide at devfra.me.

Also correct a stale API reference in the DTK0033 error page
(embeddedVisibility) and add a docs-build job to CI so a broken docs
build is caught before it silently leaves the published site on a stale
deploy.

Fixes #562
@pkg-pr-new

pkg-pr-new Bot commented Sep 15, 2026

Copy link
Copy Markdown

Open in StackBlitz

@vitejs/devtools

npm i https://pkg.pr.new/@vitejs/devtools@576

@vitejs/devtools-kit

npm i https://pkg.pr.new/@vitejs/devtools-kit@576

@vitejs/devtools-oxc

npm i https://pkg.pr.new/@vitejs/devtools-oxc@576

@vitejs/devtools-rolldown

npm i https://pkg.pr.new/@vitejs/devtools-rolldown@576

@vitejs/devtools-vite

npm i https://pkg.pr.new/@vitejs/devtools-vite@576

@vitejs/devtools-vitest

npm i https://pkg.pr.new/@vitejs/devtools-vitest@576

commit: 76f115c

… client-context, examples as concise pages

Keep the concepts on the docs site with short explanations and examples
focused on Vite-plugin usage, linking to devfra.me for the full
framework-neutral reference. Streaming, json-render, when-clauses, and
remote-client stay deferred to devfra.me.
@antfu antfu closed this Sep 15, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

website docs stale

2 participants