Skip to content

Commit f55c027

Browse files
authored
Docs update (#1494)
1 parent 67ed1b7 commit f55c027

File tree

10 files changed

+618
-383
lines changed

10 files changed

+618
-383
lines changed

docs/.vitepress/config.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ const HOSTNAME = "https://opeanpi-ts.pages.dev";
44

55
// https://vitepress.dev/reference/site-config
66
export default defineConfig({
7-
title: "OpenAPI TS",
7+
title: "OpenAPI TypeScript",
88
description: "Consume OpenAPI 3.0 & 3.1 schemas in TypeScript",
99
cleanUrls: true,
1010
srcExclude: ["**/*/CONTRIBUTRING.md", "**/*/README.md"],

docs/data/contributors.json

+1-1
Large diffs are not rendered by default.

docs/index.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
layout: home
44

55
hero:
6-
name: "OpenAPI TS"
7-
tagline: Use OpenAPI 3.0 & 3.1 schemas in TypeScript
6+
name: "OpenAPI TypeScript"
7+
tagline: Convert OpenAPI 3.0/3.1 schemas to TypeScript types and create type-safe fetching.
88
actions:
99
- theme: brand
1010
text: Get Started
@@ -14,10 +14,10 @@ hero:
1414
link: https://github.com/drwpow/openapi-typescript
1515

1616
features:
17-
- title: Platform-agnostic
18-
details: Generate TypeScript types from any OpenAPI schema, no matter how it was generated
19-
- title: Runtime-free static types
20-
details: Achieve type safety with no performance drawbacks
17+
- title: Extremely lightweight
18+
details: Static TypeScript types are runtime-free for maximum performance and minimal client weight.
19+
- title: Type-safe fetch client
20+
details: Validate requests & responses automatically using your OpenAPI schema, and throw TypeScript errors on mismatches.
2121
- title: Built on Redocly CLI
22-
details: Use Redocly’s powerful validation and schema authoring tools while reducing configuration
22+
details: Use Redocly’s powerful validation and schema authoring tools while reducing configuration.
2323
---

docs/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,6 @@
1010
"update-contributors": "node scripts/update-contributors.js"
1111
},
1212
"devDependencies": {
13-
"vitepress": "1.0.0-rc.31"
13+
"vitepress": "1.0.0-rc.32"
1414
}
1515
}

packages/openapi-fetch/examples/react-query/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,6 @@
1515
"devDependencies": {
1616
"@vitejs/plugin-react-swc": "^3.5.0",
1717
"typescript": "^5.3.3",
18-
"vite": "^5.0.8"
18+
"vite": "^5.0.10"
1919
}
2020
}

packages/openapi-fetch/examples/sveltekit/package.json

+3-3
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,12 @@
1212
"openapi-typescript": "workspace:^"
1313
},
1414
"devDependencies": {
15-
"@sveltejs/adapter-auto": "^2.1.1",
16-
"@sveltejs/kit": "^1.30.2",
15+
"@sveltejs/adapter-auto": "^3.0.1",
16+
"@sveltejs/kit": "^2.0.6",
1717
"svelte": "^4.2.8",
1818
"svelte-check": "^3.6.2",
1919
"tslib": "^2.6.2",
2020
"typescript": "^5.3.3",
21-
"vite": "^5.0.8"
21+
"vite": "^5.0.10"
2222
}
2323
}

packages/openapi-fetch/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@
7676
"openapi-typescript-fetch": "^1.1.3",
7777
"superagent": "^8.1.2",
7878
"typescript": "^5.3.3",
79-
"vitest": "^0.34.6",
79+
"vitest": "^1.1.0",
8080
"vitest-fetch-mock": "^0.2.2"
8181
}
8282
}

packages/openapi-typescript-helpers/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,6 @@
4242
"test": "tsc --noEmit"
4343
},
4444
"devDependencies": {
45-
"typescript": "^5.3.2"
45+
"typescript": "^5.3.3"
4646
}
4747
}

packages/openapi-typescript/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,6 @@
7474
"esbuild": "^0.19.9",
7575
"execa": "^7.2.0",
7676
"vite-node": "^1.0.4",
77-
"vitest": "^0.34.6"
77+
"vitest": "^1.1.0"
7878
}
7979
}

0 commit comments

Comments
 (0)