Skip to content

docs: add devframe references and guard docs build in CI - #577

Merged
antfu merged 1 commit into
mainfrom
docs/improve-and-fix-562
Sep 15, 2026
Merged

antfu merged 1 commit into
mainfrom
docs/improve-and-fix-562

Conversation

@antfubot

Copy link
Copy Markdown
Collaborator

Description

The deployed docs site was serving stale content (0.4.12), notably a Getting Started guide that still advised visibility: 'passive' — an option renamed to embeddedVisibility in #531. The repo docs were already current, so the site was stale because a broken docs:build lets Netlify keep serving the last successful deploy. CI builds the packages but never the docs site, so a docs-only breakage slips through unnoticed.

This PR:

  • Guards the docs build in CI. Adds a docs:build step to the lint job (which already builds packages) so a broken docs site fails PRs instead of silently going stale. Merging this also re-triggers a fresh Netlify deploy with current content. Edited in both src/ci.yml and the generated ci.yml to keep actionspack output consistent.
  • Focused docs polish. Adds kit-first pointers to devfra.me on the pages documenting Devframe/hub-origin features (RPC, shared state, JSON-Render, diagnostics, when clauses, commands, docks), keeping the Vite DevTools docs focused on the Vite path and sending framework-neutral detail upstream.

Linked Issues

fixes #562

Additional context

The Getting Started guide already uses the correct embeddedVisibility option; no content change was needed there. The core fix is preventing the docs deploy from silently going stale again.

This PR was created with the help of an agent.

Surface Devframe/hub-origin features (rpc, shared state, json-render,
diagnostics, when clauses, commands, docks) with kit-first pointers to
devfra.me, keeping the Vite DevTools docs focused on the Vite path.

Add a docs-build step to CI so a broken docs site fails PRs instead of
letting Netlify keep serving the last good (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@577

@vitejs/devtools-kit

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

@vitejs/devtools-oxc

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

@vitejs/devtools-rolldown

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

@vitejs/devtools-vite

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

@vitejs/devtools-vitest

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

commit: bf34677

@antfu
antfu merged commit 85c5b07 into main Sep 15, 2026
10 checks passed
@antfu
antfu deleted the docs/improve-and-fix-562 branch September 15, 2026 07:29
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