You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 554fed8
Browse filesBrowse the repository at this point in the historyBrowse files
docs: add Simplified Chinese documentation and locale support
Organize English sources under docs/en while preserving existing site and
package paths.
Add matching Chinese documentation, localized navigation, search, homepage
content, and shared theme text. Document translation maintenance and update
repository documentation links.
Copy file name to clipboardExpand all lines: AGENTS.md
+5-4Lines changed: 5 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,6 +5,7 @@ Full-stack framework for Cloudflare Workers, powered by Vite.
5
5
## Context Overview
6
6
7
7
- Documentation source lives in `docs/`.
8
+
- English and Simplified Chinese pages live in parallel `docs/en/` and `docs/zh/` trees. Follow `docs/README.md` for translation maintenance. The site rewrites English source paths to keep public URLs unchanged; bundled English docs keep their existing package paths.
8
9
- Docs is a Vitepress project using our custom theme. When asked to "link the theme", temporarily edit `docs/package.json` so that `@voidzero-dev/vitepress-theme` point to `link:../../../theme`. Rerun `vp install` to link it. Revert these when asked to "unlink the theme".
9
10
- Packages publish to npm as `void` and `@void/*`. Consumer-facing code, docs examples, playground source, and package manifests should use only those public package names.
10
11
- Published external runtime dependencies use compatible semver ranges. Preserve `workspace:*` for dependencies and peers between Void packages. The lockfile fixes the versions tested in this repository. Keep Miniflare's dated alpha coordinated with the Cloudflare toolchain: a caret does not accept the next date's alpha. Keep the Sandbox SDK version aligned with its packaged Docker helper and verified platform helper layer.
@@ -37,7 +38,7 @@ Deploy hosted production before publishing the npm packages: the CLI checks the
37
38
- When adding new CLI commands, always remember to update the following:
38
39
- CLI help message
39
40
- The hint message for command groups in the interactive list when running `void` with no args
40
-
-`docs/reference/cli.md`
41
+
-`docs/en/reference/cli.md`
41
42
42
43
## Quick Reference
43
44
@@ -77,7 +78,7 @@ pnpm workspaces managed through Vite+. Shared dependency versions use the **pnpm
|`playground/*`| (private) | local apps for testing |
79
80
80
-
The platform source is part of this repository. Its workspace-only packages keep `private: true` to prevent accidental npm publication; this does not mean the platform source is private. Use `docs/guide/platform-development.md` for contributor/fork setup and `docs/guide/self-hosted-platform.md` for installation.
81
+
The platform source is part of this repository. Its workspace-only packages keep `private: true` to prevent accidental npm publication; this does not mean the platform source is private. Use `docs/en/guide/platform-development.md` for contributor/fork setup and `docs/en/guide/self-hosted-platform.md` for installation.
81
82
82
83
Platform packages live under `platform/packages/*` and may depend on public/shared root packages. Public SDK packages under `packages/*` must not import from `platform/`.
83
84
@@ -86,8 +87,8 @@ Platform packages live under `platform/packages/*` and may depend on public/shar
86
87
Read [the core package instructions](./packages/void/AGENTS.md) for plugin,
87
88
runtime, code-generation and CLI invariants. Each framework adapter has its
88
89
own README under `packages/{react,vue,svelte,solid}`.
89
-
The [API reference](./docs/reference/api.md) and
90
-
[CLI reference](./docs/reference/cli.md) describe the supported public surface.
90
+
The [API reference](./docs/en/reference/api.md) and
91
+
[CLI reference](./docs/en/reference/cli.md) describe the supported public surface.
91
92
92
93
`packages/void/docs` is ignored by Git and copied from `docs/`
93
94
during the build. Edit the source documentation instead.
Copy file name to clipboardExpand all lines: README.md
+5-1Lines changed: 5 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ Void brings together three open-source tools for you and your coding agents:
6
6
7
7
-**Void SDK:** Build your server and client together with file-based API routes, server-rendered pages, and typed APIs for databases, storage, and AI. Carry types from database queries to the UI.
8
8
-**Void CLI:** Build your app, provision the Cloudflare resources it uses, apply migrations, and deploy with one command. Manage resources, inspect logs, and roll back through the same CLI.
9
-
-**Void Platform:** Install a shared deployment environment in your Cloudflare account for your team or customers, with access controls, resource limits, usage reporting, and [connected applications](./docs/guide/platform/administration/connected-apps.md) that request user-approved deployments.
9
+
-**Void Platform:** Install a shared deployment environment in your Cloudflare account for your team or customers, with access controls, resource limits, usage reporting, and [connected applications](./docs/en/guide/platform/administration/connected-apps.md) that request user-approved deployments.
10
10
11
11
The SDK's features are optional and composable. Use React, Vue, Svelte, or Solid for Void pages, or keep a [supported application framework](https://void.cloud/integrations/frameworks/overview) for routing and rendering while Void handles resource APIs, migrations, and deployment.
12
12
@@ -34,6 +34,10 @@ To deploy to a team platform, run `npx void connect <url>` first, then use the s
34
34
35
35
Read the [Void documentation](https://void.cloud) online or use the Markdown guides and references in `node_modules/void/docs/`, included with the `void` package.
36
36
37
+
The [Simplified Chinese guides](./docs/zh/guide/index.md) cover the introduction, quickstart, and supported app types.
38
+
39
+
See [Multilingual Documentation Maintenance](./docs/README.md) for source layout and translation reviews.
40
+
37
41
`void init` adds a minimal `AGENTS.md` in new projects and asks before changing instructions in existing projects. It also links bundled skills for detected coding agents.
38
42
39
43
-[Server routes](https://void.cloud/guide/server-routing) and [pages](https://void.cloud/guide/pages-routing/overview)
0 commit comments