From 015d8b51f473c1cb628faa2f1279650c681dd1c8 Mon Sep 17 00:00:00 2001 From: Yangshun Date: Tue, 10 Nov 2026 13:49:51 +0800 Subject: [PATCH] docs: give every page its own description Co-authored-by: Cursor --- docs/guide/ai.md | 1 + docs/guide/app-types.md | 1 + docs/guide/auth.md | 1 + docs/guide/database.md | 1 + docs/guide/database/d1.md | 1 + docs/guide/database/mysql.md | 1 + docs/guide/database/postgresql.md | 1 + docs/guide/deployment.md | 1 + docs/guide/durable-state.md | 1 + docs/guide/edge/headers.md | 1 + docs/guide/edge/prerendering.md | 1 + docs/guide/edge/redirects.md | 1 + docs/guide/edge/revalidation.md | 1 + docs/guide/edge/rewrites.md | 1 + docs/guide/edge/static-assets.md | 1 + docs/guide/email.md | 1 + docs/guide/email/domains.md | 1 + docs/guide/email/receiving.md | 1 + docs/guide/email/sending.md | 1 + docs/guide/env-vars.md | 4 ++++ docs/guide/index.md | 1 + docs/guide/jobs.md | 1 + docs/guide/kv.md | 1 + docs/guide/live.md | 1 + docs/guide/pages-routing/actions-and-forms.md | 1 + docs/guide/pages-routing/errors.md | 1 + docs/guide/pages-routing/head.md | 1 + docs/guide/pages-routing/islands.md | 1 + docs/guide/pages-routing/layouts.md | 1 + docs/guide/pages-routing/loaders.md | 1 + docs/guide/pages-routing/markdown.md | 1 + docs/guide/pages-routing/overview.md | 1 + docs/guide/pages-routing/view-transitions.md | 1 + docs/guide/platform-administration.md | 1 + docs/guide/platform-development.md | 1 + docs/guide/platform/administration/access.md | 1 + docs/guide/platform/administration/connected-apps.md | 4 ++++ docs/guide/platform/administration/email.md | 1 + docs/guide/platform/administration/operations.md | 1 + docs/guide/platform/administration/plans.md | 1 + docs/guide/platform/administration/projects.md | 1 + docs/guide/platform/administration/zero-trust.md | 1 + docs/guide/platform/development/local.md | 1 + docs/guide/platform/development/runtime.md | 1 + docs/guide/platform/development/schema-ci.md | 1 + docs/guide/platform/installation/ci.md | 1 + docs/guide/platform/installation/credentials.md | 1 + docs/guide/platform/installation/domains.md | 1 + docs/guide/platform/installation/first-deployment.md | 1 + docs/guide/platform/installation/maintenance.md | 1 + docs/guide/platform/installation/prerequisites.md | 1 + docs/guide/platform/installation/setup.md | 1 + docs/guide/platform/installation/uninstall.md | 1 + docs/guide/project-collaboration.md | 1 + docs/guide/queues.md | 1 + docs/guide/quickstart.md | 1 + docs/guide/remote-dev.md | 1 + docs/guide/sandboxes.md | 1 + docs/guide/self-hosted-platform.md | 1 + docs/guide/server-routing.md | 1 + docs/guide/sse.md | 1 + docs/guide/ssg.md | 1 + docs/guide/ssr.md | 1 + docs/guide/storage.md | 1 + docs/guide/testing.md | 1 + docs/guide/type-safety.md | 1 + docs/guide/typed-fetch.md | 1 + docs/guide/websockets.md | 1 + docs/index.md | 1 + docs/integrations/agents.md | 1 + docs/integrations/cloudflare.md | 1 + docs/integrations/frameworks/analog.md | 1 + docs/integrations/frameworks/astro.md | 1 + docs/integrations/frameworks/nuxt.md | 1 + docs/integrations/frameworks/overview.md | 1 + docs/integrations/frameworks/react-router.md | 1 + docs/integrations/frameworks/sveltekit.md | 1 + docs/integrations/frameworks/tanstack-start.md | 1 + docs/integrations/hono.md | 1 + docs/integrations/nodejs-bun-deno.md | 1 + docs/reference/api.md | 1 + docs/reference/api/auth.md | 1 + docs/reference/api/client.md | 1 + docs/reference/api/database.md | 1 + docs/reference/api/deploy.md | 4 ++++ docs/reference/api/durable.md | 1 + docs/reference/api/env.md | 1 + docs/reference/api/handlers.md | 1 + docs/reference/api/pages.md | 1 + docs/reference/api/plugin.md | 1 + docs/reference/api/resources.md | 1 + docs/reference/api/rewrites.md | 1 + docs/reference/api/types.md | 1 + docs/reference/cli.md | 1 + docs/reference/cli/auth.md | 1 + docs/reference/cli/database.md | 1 + docs/reference/cli/deploy.md | 1 + docs/reference/cli/domains.md | 1 + docs/reference/cli/email.md | 1 + docs/reference/cli/generate.md | 1 + docs/reference/cli/github.md | 1 + docs/reference/cli/platform-config.md | 1 + docs/reference/cli/platform-email.md | 1 + docs/reference/cli/platform-installation.md | 1 + docs/reference/cli/platform-operations.md | 1 + docs/reference/cli/platform-users.md | 1 + docs/reference/cli/platform-zero-trust.md | 1 + docs/reference/cli/platform.md | 1 + docs/reference/cli/project.md | 1 + docs/reference/cli/secrets.md | 1 + docs/reference/cli/setup.md | 1 + docs/reference/config.md | 1 + docs/reference/resource-inference.md | 1 + docs/reference/structure.md | 1 + 114 files changed, 123 insertions(+) diff --git a/docs/guide/ai.md b/docs/guide/ai.md index 61c6a013b..d24efbe43 100644 --- a/docs/guide/ai.md +++ b/docs/guide/ai.md @@ -1,4 +1,5 @@ --- +description: 'Run Workers AI models and provider APIs from server code. Provider requests go through Cloudflare AI Gateway.' outline: deep --- diff --git a/docs/guide/app-types.md b/docs/guide/app-types.md index 24e91204c..8e684809e 100644 --- a/docs/guide/app-types.md +++ b/docs/guide/app-types.md @@ -1,4 +1,5 @@ --- +description: 'Build a Void app, keep a meta framework, or deploy a static site. Void provisions resources and deploys each of them.' outline: deep --- diff --git a/docs/guide/auth.md b/docs/guide/auth.md index cf9c59668..916343831 100644 --- a/docs/guide/auth.md +++ b/docs/guide/auth.md @@ -1,4 +1,5 @@ --- +description: 'Add Better Auth to your app, including its database, API routes, and client. Start with email and password or a social provider.' outline: deep --- diff --git a/docs/guide/database.md b/docs/guide/database.md index 66f9ed66c..44677995a 100644 --- a/docs/guide/database.md +++ b/docs/guide/database.md @@ -1,4 +1,5 @@ --- +description: 'Define tables in TypeScript and query them with Drizzle. Use the same schema with D1, PostgreSQL, or MySQL.' outline: deep --- diff --git a/docs/guide/database/d1.md b/docs/guide/database/d1.md index 0046a6aa7..91c68fe46 100644 --- a/docs/guide/database/d1.md +++ b/docs/guide/database/d1.md @@ -1,4 +1,5 @@ --- +description: "Use Cloudflare D1, Void's default SQLite database. Void runs it locally and provisions it when you deploy." outline: deep --- diff --git a/docs/guide/database/mysql.md b/docs/guide/database/mysql.md index a6622411b..2ec3a9bc9 100644 --- a/docs/guide/database/mysql.md +++ b/docs/guide/database/mysql.md @@ -1,4 +1,5 @@ --- +description: 'Connect MySQL through Cloudflare Hyperdrive, then query it with Drizzle. Void applies your migrations on deploy.' outline: deep --- diff --git a/docs/guide/database/postgresql.md b/docs/guide/database/postgresql.md index aae99a11f..576db2383 100644 --- a/docs/guide/database/postgresql.md +++ b/docs/guide/database/postgresql.md @@ -1,4 +1,5 @@ --- +description: 'Connect PostgreSQL through Cloudflare Hyperdrive and query it with the same Drizzle workflow as D1.' outline: deep --- diff --git a/docs/guide/deployment.md b/docs/guide/deployment.md index 4ae134099..cacf4643e 100644 --- a/docs/guide/deployment.md +++ b/docs/guide/deployment.md @@ -1,4 +1,5 @@ --- +description: 'Deploy with void deploy. It builds your app, provisions resources, applies migrations, and publishes to Cloudflare or a team platform.' outline: deep --- diff --git a/docs/guide/durable-state.md b/docs/guide/durable-state.md index 9520e2c41..129f083e3 100644 --- a/docs/guide/durable-state.md +++ b/docs/guide/durable-state.md @@ -1,4 +1,5 @@ --- +description: 'Share typed state across requests with a Durable Object, such as a cart, room, or rate limiter.' outline: deep --- diff --git a/docs/guide/edge/headers.md b/docs/guide/edge/headers.md index 4f742fd84..703ab11d9 100644 --- a/docs/guide/edge/headers.md +++ b/docs/guide/edge/headers.md @@ -1,4 +1,5 @@ --- +description: 'Set custom response headers from void.config.ts. Match URL patterns to header names and values.' outline: deep --- diff --git a/docs/guide/edge/prerendering.md b/docs/guide/edge/prerendering.md index 19f8bb770..a1271bb60 100644 --- a/docs/guide/edge/prerendering.md +++ b/docs/guide/edge/prerendering.md @@ -1,4 +1,5 @@ --- +description: 'Prerender pages at deploy time so the first visitor receives cached HTML.' outline: deep --- diff --git a/docs/guide/edge/redirects.md b/docs/guide/edge/redirects.md index 8d1307392..042c8b2a2 100644 --- a/docs/guide/edge/redirects.md +++ b/docs/guide/edge/redirects.md @@ -1,4 +1,5 @@ --- +description: 'Redirect requests from void.config.ts. Map a source pattern to a destination and an optional status code.' outline: deep --- diff --git a/docs/guide/edge/revalidation.md b/docs/guide/edge/revalidation.md index 061c7607e..0370152e7 100644 --- a/docs/guide/edge/revalidation.md +++ b/docs/guide/edge/revalidation.md @@ -1,4 +1,5 @@ --- +description: 'Cache rendered pages and refresh them in the background, so visitors keep reading while a new version renders.' outline: deep --- diff --git a/docs/guide/edge/rewrites.md b/docs/guide/edge/rewrites.md index 35c4b919a..726af99b0 100644 --- a/docs/guide/edge/rewrites.md +++ b/docs/guide/edge/rewrites.md @@ -1,4 +1,5 @@ --- +description: 'Serve one route at another URL without changing the address in the browser.' outline: deep --- diff --git a/docs/guide/edge/static-assets.md b/docs/guide/edge/static-assets.md index a428326fd..33a0b4a46 100644 --- a/docs/guide/edge/static-assets.md +++ b/docs/guide/edge/static-assets.md @@ -1,4 +1,5 @@ --- +description: "Cache static assets on Cloudflare's edge. Hashed build files stay reusable across deploys." outline: deep --- diff --git a/docs/guide/email.md b/docs/guide/email.md index ad722fd33..f94aecfea 100644 --- a/docs/guide/email.md +++ b/docs/guide/email.md @@ -1,4 +1,5 @@ --- +description: 'Send transactional email, receive messages in route handlers, and inspect outgoing mail in a local inbox.' outline: deep --- diff --git a/docs/guide/email/domains.md b/docs/guide/email/domains.md index 93534926f..7449ed26c 100644 --- a/docs/guide/email/domains.md +++ b/docs/guide/email/domains.md @@ -1,4 +1,5 @@ --- +description: 'Register an email domain on a Void platform, or configure sending and receiving in your own Cloudflare account.' outline: deep --- diff --git a/docs/guide/email/receiving.md b/docs/guide/email/receiving.md index 1b521172e..aecbe65e7 100644 --- a/docs/guide/email/receiving.md +++ b/docs/guide/email/receiving.md @@ -1,4 +1,5 @@ --- +description: 'Receive mail with handlers in email/. Inbound email is available in native Void apps.' outline: deep --- diff --git a/docs/guide/email/sending.md b/docs/guide/email/sending.md index 5f49dc0c0..ec2471c28 100644 --- a/docs/guide/email/sending.md +++ b/docs/guide/email/sending.md @@ -1,4 +1,5 @@ --- +description: 'Send transactional email with sendEmail. Void captures messages in a local inbox during development.' outline: deep --- diff --git a/docs/guide/env-vars.md b/docs/guide/env-vars.md index 39155b753..ad9b8b53e 100644 --- a/docs/guide/env-vars.md +++ b/docs/guide/env-vars.md @@ -1,3 +1,7 @@ +--- +description: 'Declare environment variables in env.ts and read the typed values from void/env. Use .env locally and secrets in production.' +--- + # Environment variables Declare your environment variables in `env.ts`, then read them through `env` from `void/env`. Use `.env` for local values and `void secret put` for production server values. diff --git a/docs/guide/index.md b/docs/guide/index.md index 82bb3a0d3..e38b74192 100644 --- a/docs/guide/index.md +++ b/docs/guide/index.md @@ -1,4 +1,5 @@ --- +description: 'Void is a full-stack framework for Cloudflare Workers, powered by Vite. It connects routing, data, and deployment in one project.' outline: deep --- diff --git a/docs/guide/jobs.md b/docs/guide/jobs.md index 205954673..f0c613774 100644 --- a/docs/guide/jobs.md +++ b/docs/guide/jobs.md @@ -1,4 +1,5 @@ --- +description: 'Schedule work in crons/. Each file sets a cron expression and a handler that Void registers on deploy.' outline: deep --- diff --git a/docs/guide/kv.md b/docs/guide/kv.md index 330483650..16b1afd7e 100644 --- a/docs/guide/kv.md +++ b/docs/guide/kv.md @@ -1,4 +1,5 @@ --- +description: 'Read and write JSON in Cloudflare Workers KV. Give each collection its own key prefix and value type.' outline: deep --- diff --git a/docs/guide/live.md b/docs/guide/live.md index db51efcd7..1d5504be9 100644 --- a/docs/guide/live.md +++ b/docs/guide/live.md @@ -1,4 +1,5 @@ --- +description: 'Subscribe a browser to several topics over one SSE connection, and publish events from routes, jobs, or queues.' outline: deep --- diff --git a/docs/guide/pages-routing/actions-and-forms.md b/docs/guide/pages-routing/actions-and-forms.md index 69023da1d..9ea40c480 100644 --- a/docs/guide/pages-routing/actions-and-forms.md +++ b/docs/guide/pages-routing/actions-and-forms.md @@ -1,4 +1,5 @@ --- +description: 'Change server data from a form or button with a page action. Actions accept POST, PUT, PATCH, and DELETE.' outline: deep --- diff --git a/docs/guide/pages-routing/errors.md b/docs/guide/pages-routing/errors.md index 765410b29..922716228 100644 --- a/docs/guide/pages-routing/errors.md +++ b/docs/guide/pages-routing/errors.md @@ -1,4 +1,5 @@ --- +description: 'Show not-found and error states inside your layouts with _not-found and _error components.' outline: deep --- diff --git a/docs/guide/pages-routing/head.md b/docs/guide/pages-routing/head.md index e2c174a48..d53f44ef2 100644 --- a/docs/guide/pages-routing/head.md +++ b/docs/guide/pages-routing/head.md @@ -1,4 +1,5 @@ --- +description: 'Set a page title and metadata with head(), middleware, or site-wide defaults.' outline: deep --- diff --git a/docs/guide/pages-routing/islands.md b/docs/guide/pages-routing/islands.md index eb60f5139..7d2135168 100644 --- a/docs/guide/pages-routing/islands.md +++ b/docs/guide/pages-routing/islands.md @@ -1,4 +1,5 @@ --- +description: 'Add interactive components to a server-rendered page. Only those islands send JavaScript to the browser.' outline: deep --- diff --git a/docs/guide/pages-routing/layouts.md b/docs/guide/pages-routing/layouts.md index 13922e8d1..c8319facf 100644 --- a/docs/guide/pages-routing/layouts.md +++ b/docs/guide/pages-routing/layouts.md @@ -1,4 +1,5 @@ --- +description: 'Share navigation and other UI across pages. Layouts nest with your directories and keep their state during navigation.' outline: deep --- diff --git a/docs/guide/pages-routing/loaders.md b/docs/guide/pages-routing/loaders.md index ac1234b75..a3eb14044 100644 --- a/docs/guide/pages-routing/loaders.md +++ b/docs/guide/pages-routing/loaders.md @@ -1,4 +1,5 @@ --- +description: "Load a page's data in a companion .server.ts file. The component receives that data as typed props." outline: deep --- diff --git a/docs/guide/pages-routing/markdown.md b/docs/guide/pages-routing/markdown.md index e53b25bb4..22d3b30e8 100644 --- a/docs/guide/pages-routing/markdown.md +++ b/docs/guide/pages-routing/markdown.md @@ -1,4 +1,5 @@ --- +description: 'Add Markdown files in pages/ as routes. They inherit layouts and ship JavaScript only for islands and client scripts.' outline: deep --- diff --git a/docs/guide/pages-routing/overview.md b/docs/guide/pages-routing/overview.md index 3036b9990..46d326d55 100644 --- a/docs/guide/pages-routing/overview.md +++ b/docs/guide/pages-routing/overview.md @@ -1,4 +1,5 @@ --- +description: 'Turn files in pages/ into routes. A server loader returns data, and the page component receives it as props.' outline: deep --- diff --git a/docs/guide/pages-routing/view-transitions.md b/docs/guide/pages-routing/view-transitions.md index 9ea8d038c..b36d70a03 100644 --- a/docs/guide/pages-routing/view-transitions.md +++ b/docs/guide/pages-routing/view-transitions.md @@ -1,4 +1,5 @@ --- +description: 'Animate navigation with the View Transition API. Pages cross-fade by default, and CSS customizes the animation.' outline: deep --- diff --git a/docs/guide/platform-administration.md b/docs/guide/platform-administration.md index 72741f247..d76e8d75d 100644 --- a/docs/guide/platform-administration.md +++ b/docs/guide/platform-administration.md @@ -1,4 +1,5 @@ --- +description: 'Manage people, projects, deployment logs, and platform health from the terminal with void platform.' outline: deep --- diff --git a/docs/guide/platform-development.md b/docs/guide/platform-development.md index 72c38b80a..2068aa6d3 100644 --- a/docs/guide/platform-development.md +++ b/docs/guide/platform-development.md @@ -1,4 +1,5 @@ --- +description: 'Change the platform in this repository, test it locally, and deploy a runtime built from your fork.' outline: deep --- diff --git a/docs/guide/platform/administration/access.md b/docs/guide/platform/administration/access.md index 057c63489..98be8993a 100644 --- a/docs/guide/platform/administration/access.md +++ b/docs/guide/platform/administration/access.md @@ -1,4 +1,5 @@ --- +description: 'Sign in to the admin UI, create the first administrator, and control who can access the platform.' outline: deep --- diff --git a/docs/guide/platform/administration/connected-apps.md b/docs/guide/platform/administration/connected-apps.md index c6e92b19e..f4dbeb2c0 100644 --- a/docs/guide/platform/administration/connected-apps.md +++ b/docs/guide/platform/administration/connected-apps.md @@ -1,3 +1,7 @@ +--- +description: 'Register a separate application as an OAuth client so its users can sign in on Void and choose whether to connect it.' +--- + # Connected apps A connected app is a separate application registered as an OAuth client on your Void installation. Users sign in on Void and decide whether to connect it. The application operator may be different from the platform administrator. diff --git a/docs/guide/platform/administration/email.md b/docs/guide/platform/administration/email.md index e43ae5d72..e12e98b8c 100644 --- a/docs/guide/platform/administration/email.md +++ b/docs/guide/platform/administration/email.md @@ -1,4 +1,5 @@ --- +description: 'Manage platform email, including the shared sender, who mail may reach, and project sending domains.' outline: deep --- diff --git a/docs/guide/platform/administration/operations.md b/docs/guide/platform/administration/operations.md index 41bc895a0..728397c20 100644 --- a/docs/guide/platform/administration/operations.md +++ b/docs/guide/platform/administration/operations.md @@ -1,4 +1,5 @@ --- +description: 'Preview platform changes, follow logs, and check health from an administrator session.' outline: deep --- diff --git a/docs/guide/platform/administration/plans.md b/docs/guide/platform/administration/plans.md index b653cfc6e..57976c654 100644 --- a/docs/guide/platform/administration/plans.md +++ b/docs/guide/platform/administration/plans.md @@ -1,4 +1,5 @@ --- +description: 'Define resource limits for accounts on your platform. Plans do not bill users or purchase Cloudflare services.' outline: deep --- diff --git a/docs/guide/platform/administration/projects.md b/docs/guide/platform/administration/projects.md index 953784381..6c30428fb 100644 --- a/docs/guide/platform/administration/projects.md +++ b/docs/guide/platform/administration/projects.md @@ -1,4 +1,5 @@ --- +description: 'Find users, inspect their projects and usage, and change the plan assigned to an account.' outline: deep --- diff --git a/docs/guide/platform/administration/zero-trust.md b/docs/guide/platform/administration/zero-trust.md index 4095e320f..66cd53246 100644 --- a/docs/guide/platform/administration/zero-trust.md +++ b/docs/guide/platform/administration/zero-trust.md @@ -1,4 +1,5 @@ --- +description: 'Require Cloudflare Access sign-in on project hostnames, including custom domains, before visitors reach an app.' outline: deep --- diff --git a/docs/guide/platform/development/local.md b/docs/guide/platform/development/local.md index 18a388817..bffc45254 100644 --- a/docs/guide/platform/development/local.md +++ b/docs/guide/platform/development/local.md @@ -1,4 +1,5 @@ --- +description: 'Clone the repository, install workspace dependencies, and run the platform locally with Vite+.' outline: deep --- diff --git a/docs/guide/platform/development/runtime.md b/docs/guide/platform/development/runtime.md index 17ffa7804..0f82b9042 100644 --- a/docs/guide/platform/development/runtime.md +++ b/docs/guide/platform/development/runtime.md @@ -1,4 +1,5 @@ --- +description: 'Build a platform runtime from your checkout and deploy that build into your Cloudflare account.' outline: deep --- diff --git a/docs/guide/platform/development/schema-ci.md b/docs/guide/platform/development/schema-ci.md index f9c6aa6b7..7419178c6 100644 --- a/docs/guide/platform/development/schema-ci.md +++ b/docs/guide/platform/development/schema-ci.md @@ -1,4 +1,5 @@ --- +description: 'Change the platform database schema, generate a migration, and see how CI checks that schema.' outline: deep --- diff --git a/docs/guide/platform/installation/ci.md b/docs/guide/platform/installation/ci.md index 2f01bb5b7..321676163 100644 --- a/docs/guide/platform/installation/ci.md +++ b/docs/guide/platform/installation/ci.md @@ -1,4 +1,5 @@ --- +description: 'Install or update a Void platform from CI after you have configured it once interactively.' outline: deep --- diff --git a/docs/guide/platform/installation/credentials.md b/docs/guide/platform/installation/credentials.md index 85018ddb3..cdd13d831 100644 --- a/docs/guide/platform/installation/credentials.md +++ b/docs/guide/platform/installation/credentials.md @@ -1,4 +1,5 @@ --- +description: 'Save the credentials an installation asks for, and see which values belong in a password manager or the shell.' outline: deep --- diff --git a/docs/guide/platform/installation/domains.md b/docs/guide/platform/installation/domains.md index a37055f96..f56c60b1b 100644 --- a/docs/guide/platform/installation/domains.md +++ b/docs/guide/platform/installation/domains.md @@ -1,4 +1,5 @@ --- +description: 'Add an application domain to an installed platform, including its DNS, routing, and HTTPS certificate.' outline: deep --- diff --git a/docs/guide/platform/installation/first-deployment.md b/docs/guide/platform/installation/first-deployment.md index b2e184e60..4a08c4704 100644 --- a/docs/guide/platform/installation/first-deployment.md +++ b/docs/guide/platform/installation/first-deployment.md @@ -1,4 +1,5 @@ --- +description: 'Open the platform URL, connect the CLI, and deploy the first app into the shared Cloudflare account.' outline: deep --- diff --git a/docs/guide/platform/installation/maintenance.md b/docs/guide/platform/installation/maintenance.md index 92926f237..1b9e7bde8 100644 --- a/docs/guide/platform/installation/maintenance.md +++ b/docs/guide/platform/installation/maintenance.md @@ -1,4 +1,5 @@ --- +description: 'Resume, repair, upgrade, or recover an installation, including when the keychain or API is unavailable.' outline: deep --- diff --git a/docs/guide/platform/installation/prerequisites.md b/docs/guide/platform/installation/prerequisites.md index f098deb8f..120f793a7 100644 --- a/docs/guide/platform/installation/prerequisites.md +++ b/docs/guide/platform/installation/prerequisites.md @@ -1,4 +1,5 @@ --- +description: 'Check the Cloudflare account, domain, and API token permissions you need before installing a Void platform.' outline: deep --- diff --git a/docs/guide/platform/installation/setup.md b/docs/guide/platform/installation/setup.md index 464940c03..b67f19112 100644 --- a/docs/guide/platform/installation/setup.md +++ b/docs/guide/platform/installation/setup.md @@ -1,4 +1,5 @@ --- +description: 'Install a Void platform and choose how administrators and developers sign in.' outline: deep --- diff --git a/docs/guide/platform/installation/uninstall.md b/docs/guide/platform/installation/uninstall.md index af05c1aa3..4aee68fc9 100644 --- a/docs/guide/platform/installation/uninstall.md +++ b/docs/guide/platform/installation/uninstall.md @@ -1,4 +1,5 @@ --- +description: 'Disable a platform without deleting its data, or uninstall it and remove its Cloudflare resources.' outline: deep --- diff --git a/docs/guide/project-collaboration.md b/docs/guide/project-collaboration.md index 781e3ff4d..b2990a2ce 100644 --- a/docs/guide/project-collaboration.md +++ b/docs/guide/project-collaboration.md @@ -1,4 +1,5 @@ --- +description: 'Invite readers, collaborators, and project administrators to a hosted project. Direct Cloudflare deploys stay single-user.' outline: deep --- diff --git a/docs/guide/queues.md b/docs/guide/queues.md index 30f0c9c2f..d190b337e 100644 --- a/docs/guide/queues.md +++ b/docs/guide/queues.md @@ -1,4 +1,5 @@ --- +description: 'Process work asynchronously with a consumer in queues/, then send it typed messages from your app.' outline: deep --- diff --git a/docs/guide/quickstart.md b/docs/guide/quickstart.md index d393e204c..6e1438f19 100644 --- a/docs/guide/quickstart.md +++ b/docs/guide/quickstart.md @@ -1,4 +1,5 @@ --- +description: 'Create a Void app, run it locally, and deploy it. You can also add Void to an existing Vite app.' outline: deep --- diff --git a/docs/guide/remote-dev.md b/docs/guide/remote-dev.md index 15bba099b..ab30fee39 100644 --- a/docs/guide/remote-dev.md +++ b/docs/guide/remote-dev.md @@ -1,4 +1,5 @@ --- +description: 'Run local code against a project already deployed to your Void platform, including its database and storage.' outline: deep --- diff --git a/docs/guide/sandboxes.md b/docs/guide/sandboxes.md index 9bb930f8b..691401791 100644 --- a/docs/guide/sandboxes.md +++ b/docs/guide/sandboxes.md @@ -1,4 +1,5 @@ --- +description: 'Run commands, work with files, and connect to servers inside an isolated Cloudflare Sandbox.' outline: deep --- diff --git a/docs/guide/self-hosted-platform.md b/docs/guide/self-hosted-platform.md index eb96c9a18..5de6d821d 100644 --- a/docs/guide/self-hosted-platform.md +++ b/docs/guide/self-hosted-platform.md @@ -1,4 +1,5 @@ --- +description: 'Install a shared deployment environment in your Cloudflare account so your team can deploy without account credentials.' outline: deep --- diff --git a/docs/guide/server-routing.md b/docs/guide/server-routing.md index 221fe0e98..07c595061 100644 --- a/docs/guide/server-routing.md +++ b/docs/guide/server-routing.md @@ -1,4 +1,5 @@ --- +description: 'Add an endpoint by creating a file in routes/ and exporting a handler for each HTTP method.' outline: deep --- diff --git a/docs/guide/sse.md b/docs/guide/sse.md index 1b83eac9f..3c447d50a 100644 --- a/docs/guide/sse.md +++ b/docs/guide/sse.md @@ -1,4 +1,5 @@ --- +description: 'Stream events from a route handler to the browser. Void formats the messages, sends keepalives, and closes the stream.' outline: deep --- diff --git a/docs/guide/ssg.md b/docs/guide/ssg.md index 9efadd54f..91a2e0dfa 100644 --- a/docs/guide/ssg.md +++ b/docs/guide/ssg.md @@ -1,4 +1,5 @@ --- +description: 'Prerender every page at build time by setting the static output mode in void.config.ts.' outline: deep --- diff --git a/docs/guide/ssr.md b/docs/guide/ssr.md index 4624d41f6..19e96cd18 100644 --- a/docs/guide/ssr.md +++ b/docs/guide/ssr.md @@ -1,4 +1,5 @@ --- +description: 'Bring your own router, data loading, HTML shell, and hydration, or use Pages Routing to have Void handle them.' outline: deep --- diff --git a/docs/guide/storage.md b/docs/guide/storage.md index 01c9ee8f5..532fd46a9 100644 --- a/docs/guide/storage.md +++ b/docs/guide/storage.md @@ -1,4 +1,5 @@ --- +description: 'Store files in Cloudflare R2, and upload, download, and read metadata through void/storage.' outline: deep --- diff --git a/docs/guide/testing.md b/docs/guide/testing.md index 17d461484..f45657fe2 100644 --- a/docs/guide/testing.md +++ b/docs/guide/testing.md @@ -1,4 +1,5 @@ --- +description: 'Test a Void app with Vitest. With Vite+, run the tests through vp test.' outline: deep --- diff --git a/docs/guide/type-safety.md b/docs/guide/type-safety.md index 94a24cdb8..4b91d2edb 100644 --- a/docs/guide/type-safety.md +++ b/docs/guide/type-safety.md @@ -1,4 +1,5 @@ --- +description: 'Carry types from your database schema through route handlers and page loaders to the UI.' outline: deep --- diff --git a/docs/guide/typed-fetch.md b/docs/guide/typed-fetch.md index 90bb30d31..a4073038e 100644 --- a/docs/guide/typed-fetch.md +++ b/docs/guide/typed-fetch.md @@ -1,4 +1,5 @@ --- +description: 'Call your API from the client with a typed fetch that checks paths, request bodies, and response types.' outline: deep --- diff --git a/docs/guide/websockets.md b/docs/guide/websockets.md index bdaa1a2c6..1b06b18ab 100644 --- a/docs/guide/websockets.md +++ b/docs/guide/websockets.md @@ -1,4 +1,5 @@ --- +description: 'Send typed messages between the server and connected clients. Each route keeps its state in a Durable Object.' outline: deep --- diff --git a/docs/index.md b/docs/index.md index fb76e0505..5b42c6dfa 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,4 +1,5 @@ --- +description: 'Build with Vite and deploy with Void: a CLI, platform, and full-stack SDK for apps on Cloudflare.' layout: home theme: dark diff --git a/docs/integrations/agents.md b/docs/integrations/agents.md index 1b2c6f80d..679be25de 100644 --- a/docs/integrations/agents.md +++ b/docs/integrations/agents.md @@ -1,4 +1,5 @@ --- +description: "Set up coding agents with void init, including project instructions and links to Void's docs and skills." outline: deep --- diff --git a/docs/integrations/cloudflare.md b/docs/integrations/cloudflare.md index a35331419..c3aaf4523 100644 --- a/docs/integrations/cloudflare.md +++ b/docs/integrations/cloudflare.md @@ -1,4 +1,5 @@ --- +description: 'Deploy to Cloudflare Workers. Void detects the resources your app uses, creates bindings, and publishes the Worker.' outline: deep --- diff --git a/docs/integrations/frameworks/analog.md b/docs/integrations/frameworks/analog.md index 9c4838f81..193fce611 100644 --- a/docs/integrations/frameworks/analog.md +++ b/docs/integrations/frameworks/analog.md @@ -1,4 +1,5 @@ --- +description: 'Add Void to an Analog app for resource detection, typed database queries, migrations, and deployment.' outline: deep --- diff --git a/docs/integrations/frameworks/astro.md b/docs/integrations/frameworks/astro.md index 92340f65d..fcf280b33 100644 --- a/docs/integrations/frameworks/astro.md +++ b/docs/integrations/frameworks/astro.md @@ -1,4 +1,5 @@ --- +description: 'Add Void to an Astro app for resource detection, typed database queries, migrations, and deployment.' outline: deep --- diff --git a/docs/integrations/frameworks/nuxt.md b/docs/integrations/frameworks/nuxt.md index 680007614..137fb2a21 100644 --- a/docs/integrations/frameworks/nuxt.md +++ b/docs/integrations/frameworks/nuxt.md @@ -1,4 +1,5 @@ --- +description: 'Add Void to a Nuxt app for resource detection, typed database queries, migrations, and deployment.' outline: deep --- diff --git a/docs/integrations/frameworks/overview.md b/docs/integrations/frameworks/overview.md index 63fcce793..202de5560 100644 --- a/docs/integrations/frameworks/overview.md +++ b/docs/integrations/frameworks/overview.md @@ -1,4 +1,5 @@ --- +description: "Keep your framework's routes and rendering, and use Void for databases, storage, jobs, and deployment." outline: deep --- diff --git a/docs/integrations/frameworks/react-router.md b/docs/integrations/frameworks/react-router.md index 44b026ddc..a0a308e60 100644 --- a/docs/integrations/frameworks/react-router.md +++ b/docs/integrations/frameworks/react-router.md @@ -1,4 +1,5 @@ --- +description: 'Add Void beside the React Router Vite plugin for databases, storage, and deployment, without a separate Cloudflare adapter.' outline: deep --- diff --git a/docs/integrations/frameworks/sveltekit.md b/docs/integrations/frameworks/sveltekit.md index 3fd677c3b..58b046b2c 100644 --- a/docs/integrations/frameworks/sveltekit.md +++ b/docs/integrations/frameworks/sveltekit.md @@ -1,4 +1,5 @@ --- +description: 'Add Void to a SvelteKit app for resource detection, typed database queries, migrations, and deployment.' outline: deep --- diff --git a/docs/integrations/frameworks/tanstack-start.md b/docs/integrations/frameworks/tanstack-start.md index b293e65c0..4ca758074 100644 --- a/docs/integrations/frameworks/tanstack-start.md +++ b/docs/integrations/frameworks/tanstack-start.md @@ -1,4 +1,5 @@ --- +description: 'Add Void beside the TanStack Start Vite plugin for databases, storage, and deployment, without a separate Cloudflare adapter.' outline: deep --- diff --git a/docs/integrations/hono.md b/docs/integrations/hono.md index 25145f5e8..c96160611 100644 --- a/docs/integrations/hono.md +++ b/docs/integrations/hono.md @@ -1,4 +1,5 @@ --- +description: 'Void route handlers run on Hono. Add hono to your app when your code imports from it directly.' outline: deep --- diff --git a/docs/integrations/nodejs-bun-deno.md b/docs/integrations/nodejs-bun-deno.md index 785fa030a..13952b812 100644 --- a/docs/integrations/nodejs-bun-deno.md +++ b/docs/integrations/nodejs-bun-deno.md @@ -1,4 +1,5 @@ --- +description: 'Build a Void server for Node.js, Bun, or Deno, and run it on your own machine, in a container, or with another host.' outline: deep --- diff --git a/docs/reference/api.md b/docs/reference/api.md index 88ebedc7d..b5460f654 100644 --- a/docs/reference/api.md +++ b/docs/reference/api.md @@ -1,4 +1,5 @@ --- +description: 'Look up public imports, signatures, and return types. The guides cover setup and examples.' outline: deep --- diff --git a/docs/reference/api/auth.md b/docs/reference/api/auth.md index 1aee6b736..c83f0c9a5 100644 --- a/docs/reference/api/auth.md +++ b/docs/reference/api/auth.md @@ -1,4 +1,5 @@ --- +description: 'Sessions, users, and auth clients from void/auth, plus the browser helpers in void/client.' outline: deep --- diff --git a/docs/reference/api/client.md b/docs/reference/api/client.md index 5eb930a3a..86b719fa3 100644 --- a/docs/reference/api/client.md +++ b/docs/reference/api/client.md @@ -1,4 +1,5 @@ --- +description: 'Call your routes from client code with a typed fetch. Paths and response types come from the generated route map.' outline: deep --- diff --git a/docs/reference/api/database.md b/docs/reference/api/database.md index 5b234573d..e6a3269aa 100644 --- a/docs/reference/api/database.md +++ b/docs/reference/api/database.md @@ -1,4 +1,5 @@ --- +description: 'Query D1, PostgreSQL, or MySQL with the Drizzle client from void/db, and seed data from a script.' outline: deep --- diff --git a/docs/reference/api/deploy.md b/docs/reference/api/deploy.md index 8e0d0ea6f..3a32be3ef 100644 --- a/docs/reference/api/deploy.md +++ b/docs/reference/api/deploy.md @@ -1,3 +1,7 @@ +--- +description: 'Prepare a built app, SPA, or static site for a managed platform deployment without platform credentials.' +--- + # Deployment artifacts Use `void/deploy` from Node.js to prepare a built Void app, SPA, or static site for a managed platform deployment without platform credentials. diff --git a/docs/reference/api/durable.md b/docs/reference/api/durable.md index a796f5350..1a4fe5b58 100644 --- a/docs/reference/api/durable.md +++ b/docs/reference/api/durable.md @@ -1,4 +1,5 @@ --- +description: 'Persistent objects and typed WebSocket connections from void/durable.' outline: deep --- diff --git a/docs/reference/api/env.md b/docs/reference/api/env.md index ba26e9f3d..234a3fc36 100644 --- a/docs/reference/api/env.md +++ b/docs/reference/api/env.md @@ -1,4 +1,5 @@ --- +description: 'Read validated environment values and binding types from void/env.' outline: deep --- diff --git a/docs/reference/api/handlers.md b/docs/reference/api/handlers.md index 5c057f399..1c72ce269 100644 --- a/docs/reference/api/handlers.md +++ b/docs/reference/api/handlers.md @@ -1,4 +1,5 @@ --- +description: 'Define HTTP handlers, middleware, validation, scheduled jobs, queues, and rendering.' outline: deep --- diff --git a/docs/reference/api/pages.md b/docs/reference/api/pages.md index ee1706d84..d1a5f73da 100644 --- a/docs/reference/api/pages.md +++ b/docs/reference/api/pages.md @@ -1,4 +1,5 @@ --- +description: 'Vite plugins and client runtimes for React, Vue, Svelte, and Solid pages.' outline: deep --- diff --git a/docs/reference/api/plugin.md b/docs/reference/api/plugin.md index 3298bdfee..41fa8c356 100644 --- a/docs/reference/api/plugin.md +++ b/docs/reference/api/plugin.md @@ -1,4 +1,5 @@ --- +description: 'Add Void to Vite. The plugin sets up routing, migrations, and the Cloudflare Workers runtime.' outline: deep --- diff --git a/docs/reference/api/resources.md b/docs/reference/api/resources.md index ea3eb01c9..9a23824d3 100644 --- a/docs/reference/api/resources.md +++ b/docs/reference/api/resources.md @@ -1,4 +1,5 @@ --- +description: 'Clients for KV, object storage, AI, cache revalidation, and logs.' outline: deep --- diff --git a/docs/reference/api/rewrites.md b/docs/reference/api/rewrites.md index d11bdd0d4..2274840ff 100644 --- a/docs/reference/api/rewrites.md +++ b/docs/reference/api/rewrites.md @@ -1,4 +1,5 @@ --- +description: 'Serve another route without changing the browser URL, and read the URL that was originally requested.' outline: deep --- diff --git a/docs/reference/api/types.md b/docs/reference/api/types.md index 9b7a4d9fe..9f3cffe91 100644 --- a/docs/reference/api/types.md +++ b/docs/reference/api/types.md @@ -1,4 +1,5 @@ --- +description: 'Shared types for handler context, routes, URLs, and head metadata.' outline: deep --- diff --git a/docs/reference/cli.md b/docs/reference/cli.md index 848b5307a..a7aef9298 100644 --- a/docs/reference/cli.md +++ b/docs/reference/cli.md @@ -1,4 +1,5 @@ --- +description: 'Commands for creating a project, deploying it, and managing databases, secrets, domains, and a platform.' outline: deep --- diff --git a/docs/reference/cli/auth.md b/docs/reference/cli/auth.md index 8ace1562d..3ca7c3d33 100644 --- a/docs/reference/cli/auth.md +++ b/docs/reference/cli/auth.md @@ -1,4 +1,5 @@ --- +description: 'Connect the CLI to Cloudflare or a Void platform, and sign in to the account that receives deploys.' outline: deep --- diff --git a/docs/reference/cli/database.md b/docs/reference/cli/database.md index e302b58a0..7357d978e 100644 --- a/docs/reference/cli/database.md +++ b/docs/reference/cli/database.md @@ -1,4 +1,5 @@ --- +description: 'Generate migrations, apply them, and update the local database from your Drizzle schema.' outline: deep --- diff --git a/docs/reference/cli/deploy.md b/docs/reference/cli/deploy.md index bd5e978a9..cceef5015 100644 --- a/docs/reference/cli/deploy.md +++ b/docs/reference/cli/deploy.md @@ -1,4 +1,5 @@ --- +description: 'Build an app, provision its resources, apply migrations, and publish it.' outline: deep --- diff --git a/docs/reference/cli/domains.md b/docs/reference/cli/domains.md index 1e9eeb2d6..61a238f00 100644 --- a/docs/reference/cli/domains.md +++ b/docs/reference/cli/domains.md @@ -1,4 +1,5 @@ --- +description: 'Add, remove, and check custom domains for a hosted project or a direct Cloudflare deploy.' outline: deep --- diff --git a/docs/reference/cli/email.md b/docs/reference/cli/email.md index a6312b99d..525477b17 100644 --- a/docs/reference/cli/email.md +++ b/docs/reference/cli/email.md @@ -1,4 +1,5 @@ --- +description: 'Inspect email usage and choose the recipients a project is allowed to send to.' outline: deep --- diff --git a/docs/reference/cli/generate.md b/docs/reference/cli/generate.md index 56977637a..15715b56a 100644 --- a/docs/reference/cli/generate.md +++ b/docs/reference/cli/generate.md @@ -1,4 +1,5 @@ --- +description: 'Scaffold a Drizzle table and the routes that list, create, and fetch a row.' outline: deep --- diff --git a/docs/reference/cli/github.md b/docs/reference/cli/github.md index 0e6e60cae..594591193 100644 --- a/docs/reference/cli/github.md +++ b/docs/reference/cli/github.md @@ -1,4 +1,5 @@ --- +description: 'Connect GitHub so pushes build and deploy, whichever way you signed in to Void.' outline: deep --- diff --git a/docs/reference/cli/platform-config.md b/docs/reference/cli/platform-config.md index aa0c98af3..4186d400c 100644 --- a/docs/reference/cli/platform-config.md +++ b/docs/reference/cli/platform-config.md @@ -1,4 +1,5 @@ --- +description: 'Create and edit platform plans and their limits from an administrator session.' outline: deep --- diff --git a/docs/reference/cli/platform-email.md b/docs/reference/cli/platform-email.md index 13ccceacc..800767091 100644 --- a/docs/reference/cli/platform-email.md +++ b/docs/reference/cli/platform-email.md @@ -1,4 +1,5 @@ --- +description: 'Administer platform email, including the shared sender and project recipient rules.' outline: deep --- diff --git a/docs/reference/cli/platform-installation.md b/docs/reference/cli/platform-installation.md index efae6f189..cf573d835 100644 --- a/docs/reference/cli/platform-installation.md +++ b/docs/reference/cli/platform-installation.md @@ -1,4 +1,5 @@ --- +description: 'Install a Void platform from the CLI, set its domain, and run its lifecycle commands.' outline: deep --- diff --git a/docs/reference/cli/platform-operations.md b/docs/reference/cli/platform-operations.md index f550b18b3..a34a9080f 100644 --- a/docs/reference/cli/platform-operations.md +++ b/docs/reference/cli/platform-operations.md @@ -1,4 +1,5 @@ --- +description: 'Inspect deployments, logs, and platform health, and preview changes before applying them.' outline: deep --- diff --git a/docs/reference/cli/platform-users.md b/docs/reference/cli/platform-users.md index a2138b074..a8ea714c0 100644 --- a/docs/reference/cli/platform-users.md +++ b/docs/reference/cli/platform-users.md @@ -1,4 +1,5 @@ --- +description: 'Manage platform users, their projects, and the plans assigned to their accounts.' outline: deep --- diff --git a/docs/reference/cli/platform-zero-trust.md b/docs/reference/cli/platform-zero-trust.md index d86f13565..20d29a4e3 100644 --- a/docs/reference/cli/platform-zero-trust.md +++ b/docs/reference/cli/platform-zero-trust.md @@ -1,4 +1,5 @@ --- +description: 'Turn Cloudflare Access on or off for project hostnames from an administrator session.' outline: deep --- diff --git a/docs/reference/cli/platform.md b/docs/reference/cli/platform.md index 1f887d293..44a003a3a 100644 --- a/docs/reference/cli/platform.md +++ b/docs/reference/cli/platform.md @@ -1,4 +1,5 @@ --- +description: 'Select a platform, confirm changes, and run operator commands against that installation.' outline: deep --- diff --git a/docs/reference/cli/project.md b/docs/reference/cli/project.md index b96308e88..ec427f8c2 100644 --- a/docs/reference/cli/project.md +++ b/docs/reference/cli/project.md @@ -1,4 +1,5 @@ --- +description: 'Link a directory to a hosted project, then inspect deployments, logs, access, and rollbacks.' outline: deep --- diff --git a/docs/reference/cli/secrets.md b/docs/reference/cli/secrets.md index af49dc8b9..ae771a2cb 100644 --- a/docs/reference/cli/secrets.md +++ b/docs/reference/cli/secrets.md @@ -1,4 +1,5 @@ --- +description: 'List, set, and remove production secrets. Secret values are never printed.' outline: deep --- diff --git a/docs/reference/cli/setup.md b/docs/reference/cli/setup.md index cd707e806..cdaeba5a1 100644 --- a/docs/reference/cli/setup.md +++ b/docs/reference/cli/setup.md @@ -1,4 +1,5 @@ --- +description: 'Create a project with void init, prepare generated files, and inspect inferred resources.' outline: deep --- diff --git a/docs/reference/config.md b/docs/reference/config.md index f1a981063..38d767cfc 100644 --- a/docs/reference/config.md +++ b/docs/reference/config.md @@ -1,4 +1,5 @@ --- +description: 'Configure routing, inference, output, and the deployment target in void.config.ts.' outline: deep --- diff --git a/docs/reference/resource-inference.md b/docs/reference/resource-inference.md index de14f98f3..0f0e3104b 100644 --- a/docs/reference/resource-inference.md +++ b/docs/reference/resource-inference.md @@ -1,4 +1,5 @@ --- +description: 'Void detects the Cloudflare resources your code uses and provisions the matching bindings. Manual configuration is optional.' outline: deep --- diff --git a/docs/reference/structure.md b/docs/reference/structure.md index 0397e7bbf..954d5818b 100644 --- a/docs/reference/structure.md +++ b/docs/reference/structure.md @@ -1,4 +1,5 @@ --- +description: 'See how routes, pages, middleware, and other optional directories map onto a Void app.' outline: deep ---