Docs update (#1494)

openapi-ts · Dec 24, 2023 · f55c027 · f55c027
1 parent 67ed1b7
commit f55c027
Show file tree

Hide file tree

Showing 10 changed files with 618 additions and 383 deletions.
diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts
@@ -4,7 +4,7 @@ const HOSTNAME = "https://opeanpi-ts.pages.dev";
 
 // https://vitepress.dev/reference/site-config
 export default defineConfig({
-  title: "OpenAPI TS",
+  title: "OpenAPI TypeScript",
   description: "Consume OpenAPI 3.0 & 3.1 schemas in TypeScript",
   cleanUrls: true,
   srcExclude: ["**/*/CONTRIBUTRING.md", "**/*/README.md"],

diff --git a/docs/data/contributors.json b/docs/data/contributors.json
diff --git a/docs/index.md b/docs/index.md
@@ -3,8 +3,8 @@
 layout: home
 
 hero:
-  name: "OpenAPI TS"
-  tagline: Use OpenAPI 3.0 & 3.1 schemas in TypeScript
+  name: "OpenAPI TypeScript"
+  tagline: Convert OpenAPI 3.0/3.1 schemas to TypeScript types and create type-safe fetching.
   actions:
     - theme: brand
       text: Get Started
@@ -14,10 +14,10 @@ hero:
       link: https://github.com/drwpow/openapi-typescript
 
 features:
-  - title: Platform-agnostic
-    details: Generate TypeScript types from any OpenAPI schema, no matter how it was generated
-  - title: Runtime-free static types
-    details: Achieve type safety with no performance drawbacks
+  - title: Extremely lightweight
+    details: Static TypeScript types are runtime-free for maximum performance and minimal client weight.
+  - title: Type-safe fetch client
+    details: Validate requests & responses automatically using your OpenAPI schema, and throw TypeScript errors on mismatches.
   - title: Built on Redocly CLI
-    details: Use Redocly’s powerful validation and schema authoring tools while reducing configuration
+    details: Use Redocly’s powerful validation and schema authoring tools while reducing configuration.
 ---
diff --git a/docs/package.json b/docs/package.json
@@ -10,6 +10,6 @@
     "update-contributors": "node scripts/update-contributors.js"
   },
   "devDependencies": {
-    "vitepress": "1.0.0-rc.31"
+    "vitepress": "1.0.0-rc.32"
   }
 }
diff --git a/packages/openapi-fetch/examples/react-query/package.json b/packages/openapi-fetch/examples/react-query/package.json
@@ -15,6 +15,6 @@
   "devDependencies": {
     "@vitejs/plugin-react-swc": "^3.5.0",
     "typescript": "^5.3.3",
-    "vite": "^5.0.8"
+    "vite": "^5.0.10"
   }
 }
diff --git a/packages/openapi-fetch/examples/sveltekit/package.json b/packages/openapi-fetch/examples/sveltekit/package.json
@@ -12,12 +12,12 @@
     "openapi-typescript": "workspace:^"
   },
   "devDependencies": {
-    "@sveltejs/adapter-auto": "^2.1.1",
-    "@sveltejs/kit": "^1.30.2",
+    "@sveltejs/adapter-auto": "^3.0.1",
+    "@sveltejs/kit": "^2.0.6",
     "svelte": "^4.2.8",
     "svelte-check": "^3.6.2",
     "tslib": "^2.6.2",
     "typescript": "^5.3.3",
-    "vite": "^5.0.8"
+    "vite": "^5.0.10"
   }
 }
diff --git a/packages/openapi-fetch/package.json b/packages/openapi-fetch/package.json
@@ -76,7 +76,7 @@
     "openapi-typescript-fetch": "^1.1.3",
     "superagent": "^8.1.2",
     "typescript": "^5.3.3",
-    "vitest": "^0.34.6",
+    "vitest": "^1.1.0",
     "vitest-fetch-mock": "^0.2.2"
   }
 }
diff --git a/packages/openapi-typescript-helpers/package.json b/packages/openapi-typescript-helpers/package.json
@@ -42,6 +42,6 @@
     "test": "tsc --noEmit"
   },
   "devDependencies": {
-    "typescript": "^5.3.2"
+    "typescript": "^5.3.3"
   }
 }
diff --git a/packages/openapi-typescript/package.json b/packages/openapi-typescript/package.json
@@ -74,6 +74,6 @@
     "esbuild": "^0.19.9",
     "execa": "^7.2.0",
     "vite-node": "^1.0.4",
-    "vitest": "^0.34.6"
+    "vitest": "^1.1.0"
   }
 }