add initial changesets

arktypeio · May 22, 2024 · 8cd0807 · 8cd0807
1 parent 6e39e69
commit 8cd0807
Show file tree

Hide file tree

Showing 7 changed files with 24 additions and 13 deletions.
diff --git a/ark/type/.changeset/config.json → .changeset/config.json b/ark/type/.changeset/config.json → .changeset/config.json
diff --git a/.changeset/cool-buses-fix.md 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
@@ -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
@@ -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
diff --git a/ark/type/.changeset/cool-rice-call.md → ark/repo/scratch/cool-rice-call.md b/ark/type/.changeset/cool-rice-call.md → ark/repo/scratch/cool-rice-call.md
diff --git a/ark/type/.changeset/smart-suns-do.md → ark/repo/scratch/smart-suns-do.md b/ark/type/.changeset/smart-suns-do.md → ark/repo/scratch/smart-suns-do.md