From 8cd080783fdbd8eefea54d5c04d99cd88b36c0eb Mon Sep 17 00:00:00 2001 From: David Blass Date: Wed, 22 May 2024 16:50:11 -0400 Subject: [PATCH] add initial changesets --- {ark/type/.changeset => .changeset}/config.json | 0 .changeset/cool-buses-fix.md | 9 +++++++++ ark/docs/src/content/docs/index.mdx | 2 +- ark/docs/src/content/docs/intro/install.md | 14 ++++++++++++++ ark/docs/src/content/docs/intro/why.md | 12 ------------ .../.changeset => repo/scratch}/cool-rice-call.md | 0 .../.changeset => repo/scratch}/smart-suns-do.md | 0 7 files changed, 24 insertions(+), 13 deletions(-) rename {ark/type/.changeset => .changeset}/config.json (100%) create mode 100644 .changeset/cool-buses-fix.md create mode 100644 ark/docs/src/content/docs/intro/install.md delete mode 100644 ark/docs/src/content/docs/intro/why.md rename ark/{type/.changeset => repo/scratch}/cool-rice-call.md (100%) rename ark/{type/.changeset => repo/scratch}/smart-suns-do.md (100%) diff --git a/ark/type/.changeset/config.json b/.changeset/config.json similarity index 100% rename from ark/type/.changeset/config.json rename to .changeset/config.json diff --git a/.changeset/cool-buses-fix.md b/.changeset/cool-buses-fix.md new file mode 100644 index 0000000000..c6c64bf47d --- /dev/null +++ b/.changeset/cool-buses-fix.md @@ -0,0 +1,9 @@ +--- +"@arktype/attest": patch +"@arktype/fs": patch +"@arktype/schema": patch +"arktype": patch +"@arktype/util": patch +--- + +Initial changeset diff --git a/ark/docs/src/content/docs/index.mdx b/ark/docs/src/content/docs/index.mdx index e58748d2d6..91d82bdefc 100644 --- a/ark/docs/src/content/docs/index.mdx +++ b/ark/docs/src/content/docs/index.mdx @@ -10,7 +10,7 @@ hero: file: ../../assets/splash.png actions: - text: Set sail - link: /intro/why/ + link: /intro/install/ icon: right-arrow variant: primary - text: Doc up diff --git a/ark/docs/src/content/docs/intro/install.md b/ark/docs/src/content/docs/intro/install.md new file mode 100644 index 0000000000..40ef2cc547 --- /dev/null +++ b/ark/docs/src/content/docs/intro/install.md @@ -0,0 +1,14 @@ +--- +title: Getting Started +--- + +## Installation + +```bash +# (or whatever package manager you prefer) +npm install arktype +``` + +Our types are tested in [strict-mode](https://www.typescriptlang.org/tsconfig#strict) with TypeScript version `5.1+`. + +If your types work but you notice errors in node_modules, this could be due to `tsconfig` incompatibilities- please enable `compilerOptions/skipLibCheck` ([docs](https://www.typescriptlang.org/tsconfig/#skipLibCheck)). diff --git a/ark/docs/src/content/docs/intro/why.md b/ark/docs/src/content/docs/intro/why.md deleted file mode 100644 index a720fcdeb4..0000000000 --- a/ark/docs/src/content/docs/intro/why.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Example Guide -description: A guide in my new Starlight docs site. ---- - -## Why use it? - -- **Concision**: - - Definitions: About 1/2 as long as equivalent Zod on average - - Types: Tooltips are 1/5 the length of Zod on average -- **Portability**: - - Definitions are just strings and objects and are serializable by default. diff --git a/ark/type/.changeset/cool-rice-call.md b/ark/repo/scratch/cool-rice-call.md similarity index 100% rename from ark/type/.changeset/cool-rice-call.md rename to ark/repo/scratch/cool-rice-call.md diff --git a/ark/type/.changeset/smart-suns-do.md b/ark/repo/scratch/smart-suns-do.md similarity index 100% rename from ark/type/.changeset/smart-suns-do.md rename to ark/repo/scratch/smart-suns-do.md