From eb7962d5b0d6bf2699ba2fae09faab8e0a968479 Mon Sep 17 00:00:00 2001 From: ymc9 <104139426+ymc9@users.noreply.github.com> Date: Tue, 2 Jun 2026 19:39:05 -0700 Subject: [PATCH] docs: move Quick Start to top-level after Prerequisite Relocate the Quick Start guide from the ORM section to a top-level doc positioned right after Prerequisite. Fix its relative imports and the CLI reference link, and shift the following sidebar positions down by one to make room. Co-Authored-By: Claude Opus 4.8 --- docs/community-packages.md | 2 +- docs/migrate-prisma.md | 2 +- docs/migrate-v2.md | 2 +- docs/modeling/_category_.yml | 2 +- docs/orm/_category_.yml | 2 +- docs/{orm => }/quick-start.md | 12 ++++++------ docs/recipe/_category_.yml | 2 +- docs/reference/_category_.yml | 2 +- docs/samples.md | 2 +- docs/service/_category_.yml | 2 +- docs/studio.md | 2 +- docs/utilities/_category_.yml | 2 +- 12 files changed, 17 insertions(+), 17 deletions(-) rename docs/{orm => }/quick-start.md (86%) diff --git a/docs/community-packages.md b/docs/community-packages.md index 04ae7512..0a2271a5 100644 --- a/docs/community-packages.md +++ b/docs/community-packages.md @@ -1,5 +1,5 @@ --- -sidebar_position: 10 +sidebar_position: 11 sidebar_label: Community Packages --- diff --git a/docs/migrate-prisma.md b/docs/migrate-prisma.md index f710ae9a..3b5f4ccb 100644 --- a/docs/migrate-prisma.md +++ b/docs/migrate-prisma.md @@ -1,6 +1,6 @@ --- description: How to migrate from a Prisma project to ZenStack v3 -sidebar_position: 12 +sidebar_position: 13 --- import PackageInstall from './_components/PackageInstall'; diff --git a/docs/migrate-v2.md b/docs/migrate-v2.md index 807e7d43..16ff904b 100644 --- a/docs/migrate-v2.md +++ b/docs/migrate-v2.md @@ -1,6 +1,6 @@ --- description: How to migrate from a ZenStack v2 project to v3 -sidebar_position: 13 +sidebar_position: 14 --- import PackageInstall from './_components/PackageInstall'; diff --git a/docs/modeling/_category_.yml b/docs/modeling/_category_.yml index 9f8d1691..658d7ab7 100644 --- a/docs/modeling/_category_.yml +++ b/docs/modeling/_category_.yml @@ -1,4 +1,4 @@ -position: 3 +position: 4 label: Data Modeling collapsible: true collapsed: true diff --git a/docs/orm/_category_.yml b/docs/orm/_category_.yml index 8e6b7172..52448c97 100644 --- a/docs/orm/_category_.yml +++ b/docs/orm/_category_.yml @@ -1,4 +1,4 @@ -position: 4 +position: 5 label: ORM collapsible: true collapsed: true diff --git a/docs/orm/quick-start.md b/docs/quick-start.md similarity index 86% rename from docs/orm/quick-start.md rename to docs/quick-start.md index 84da02c1..65006400 100644 --- a/docs/orm/quick-start.md +++ b/docs/quick-start.md @@ -1,13 +1,13 @@ --- -sidebar_position: 1 +sidebar_position: 3 description: Quick start guide --- import StackBlitzGithub from '@site/src/components/StackBlitzGithub'; -import ZModelStarter from '../_components/_zmodel-starter.md'; -import PackageInstall from '../_components/PackageInstall'; -import PackageExec from '../_components/PackageExec'; -import PackageDlx from '../_components/PackageDlx'; +import ZModelStarter from './_components/_zmodel-starter.md'; +import PackageInstall from './_components/PackageInstall'; +import PackageExec from './_components/PackageExec'; +import PackageDlx from './_components/PackageDlx'; # Quick Start @@ -59,7 +59,7 @@ You can also always configure a project manually with the following steps: :::info -By default, ZenStack CLI loads the schema from `zenstack/schema.zmodel`. You can change this by passing the `--schema` option. TypeScript files are by default generated to the same directory as the schema file. You can change this by passing the `--output` option. The default settings can also be changed as explained in the [CLI reference](../reference/cli#overriding-default-options). +By default, ZenStack CLI loads the schema from `zenstack/schema.zmodel`. You can change this by passing the `--schema` option. TypeScript files are by default generated to the same directory as the schema file. You can change this by passing the `--output` option. The default settings can also be changed as explained in the [CLI reference](./reference/cli#overriding-default-options). You can choose to either commit the generated TypeScript files to your source control (recommended), or add them to `.gitignore` and generate them on the fly in your CI/CD pipeline. diff --git a/docs/recipe/_category_.yml b/docs/recipe/_category_.yml index 41f39a88..9c3eb4bd 100644 --- a/docs/recipe/_category_.yml +++ b/docs/recipe/_category_.yml @@ -1,4 +1,4 @@ -position: 8 +position: 9 label: Recipes collapsible: true collapsed: true diff --git a/docs/reference/_category_.yml b/docs/reference/_category_.yml index 7eb8cd47..11fe0ecf 100644 --- a/docs/reference/_category_.yml +++ b/docs/reference/_category_.yml @@ -1,4 +1,4 @@ -position: 9 +position: 10 label: Reference collapsible: true collapsed: true diff --git a/docs/samples.md b/docs/samples.md index 01fd70bd..f5504211 100644 --- a/docs/samples.md +++ b/docs/samples.md @@ -1,5 +1,5 @@ --- -sidebar_position: 11 +sidebar_position: 12 sidebar_label: Sample Projects --- diff --git a/docs/service/_category_.yml b/docs/service/_category_.yml index 938fc11d..f15df837 100644 --- a/docs/service/_category_.yml +++ b/docs/service/_category_.yml @@ -1,4 +1,4 @@ -position: 5 +position: 6 label: Query as a Service collapsible: true collapsed: true diff --git a/docs/studio.md b/docs/studio.md index 83bc323a..12fd1154 100644 --- a/docs/studio.md +++ b/docs/studio.md @@ -1,5 +1,5 @@ --- -sidebar_position: 7 +sidebar_position: 8 sidebar_label: Studio --- diff --git a/docs/utilities/_category_.yml b/docs/utilities/_category_.yml index 1fdb7623..7d12d491 100644 --- a/docs/utilities/_category_.yml +++ b/docs/utilities/_category_.yml @@ -1,4 +1,4 @@ -position: 6 +position: 7 label: Utilities collapsible: true collapsed: true