From 63f3a1646ea0d3c93dea66d48b50f5c8b2ed1109 Mon Sep 17 00:00:00 2001 From: Lubos Date: Fri, 26 Dec 2025 01:42:16 +0800 Subject: [PATCH] docs: update copy --- docs/.vitepress/config/en.ts | 2 +- docs/.vitepress/config/shared.ts | 2 +- docs/.vitepress/theme/components/Layout.vue | 4 +-- docs/.vitepress/theme/custom.css | 4 +++ docs/index.md | 26 ++++++++++---------- docs/openapi-ts/get-started.md | 19 +++++++++------ docs/partials/sponsors.md | 2 +- packages/openapi-ts/README.md | 27 +++++++++++---------- packages/openapi-ts/package.json | 2 +- 9 files changed, 48 insertions(+), 40 deletions(-) diff --git a/docs/.vitepress/config/en.ts b/docs/.vitepress/config/en.ts index c1623acb0..977475f25 100644 --- a/docs/.vitepress/config/en.ts +++ b/docs/.vitepress/config/en.ts @@ -2,7 +2,7 @@ import { defineConfig } from 'vitepress'; export default defineConfig({ description: - 'πŸŒ€ OpenAPI to TypeScript code generator. Generate API clients, SDKs, validators, and more.', + 'πŸŒ€ OpenAPI to TypeScript codegen. Production-ready SDKs, Zod schemas, TanStack Query hooks, and 20+ plugins. Used by Vercel, OpenCode, and PayPal.', lang: 'en-US', themeConfig: { editLink: { diff --git a/docs/.vitepress/config/shared.ts b/docs/.vitepress/config/shared.ts index 37bc0ec93..3a7e1a017 100644 --- a/docs/.vitepress/config/shared.ts +++ b/docs/.vitepress/config/shared.ts @@ -98,7 +98,7 @@ export default defineConfig({ { content: pageData.frontmatter.description || - 'πŸŒ€ OpenAPI to TypeScript code generator. Generate API clients, SDKs, validators, and more.', + 'πŸŒ€ OpenAPI to TypeScript codegen. Production-ready SDKs, Zod schemas, TanStack Query hooks, and 20+ plugins. Used by Vercel, OpenCode, and PayPal.', property: 'og:description', }, ], diff --git a/docs/.vitepress/theme/components/Layout.vue b/docs/.vitepress/theme/components/Layout.vue index 7eb058bca..da4b7667f 100644 --- a/docs/.vitepress/theme/components/Layout.vue +++ b/docs/.vitepress/theme/components/Layout.vue @@ -8,12 +8,12 @@ const { Layout } = DefaultTheme; diff --git a/docs/.vitepress/theme/custom.css b/docs/.vitepress/theme/custom.css index 5156f37e3..171e6e946 100644 --- a/docs/.vitepress/theme/custom.css +++ b/docs/.vitepress/theme/custom.css @@ -401,6 +401,10 @@ a.migration:focus { } @media (min-width: 640px) { + h1.heading .name { + max-width: 600px; + } + .VPFeatures.VPHomeFeatures > .container > .items { gap: 1rem; padding: 0.4rem 0; diff --git a/docs/index.md b/docs/index.md index 4308f5492..b1994f7c9 100644 --- a/docs/index.md +++ b/docs/index.md @@ -2,8 +2,8 @@ layout: home hero: - name: One OpenAPI spec.
Infinite outputs. - tagline: Code generator for TypeScript projects. Trusted by companies like Google, Amazon, and PayPal to generate API clients, SDKs, validators, and more. + name: OpenAPI to TypeScript in seconds. + tagline: Generate production-ready SDKs and validators from your OpenAPI spec. Used by Vercel, OpenCode, and PayPal. actions: - link: /openapi-ts/get-started text: Get Started @@ -20,33 +20,33 @@ hero: features: - icon: - title: OpenAPI Schema - details: You provide OpenAPI schema. We take care of the rest. OpenAPI 2.0, 3.0, and 3.1 supported. + title: OpenAPI to TypeScript + details: Generate production-ready TypeScript from any OpenAPI specification. link: /openapi-ts/get-started linkText: Get started - icon: - title: Types and SDKs - details: Highly customizable output with sensible defaults. No manual maintenance required. + title: Instant SDKs + details: Highly customizable SDKs and types with sensible defaults that compile out of the box. link: /openapi-ts/output linkText: See output - icon: - title: Clients - details: Type-safe data with REST clients for your runtime. Fetch API, Angular, Next.js, Nuxt and more. + title: HTTP Clients + details: Pluggable HTTP clients for Fetch API, Angular, Axios, Next.js, Nuxt, and more. link: /openapi-ts/clients linkText: Explore clients - icon: - title: Plugins - details: Reduce third-party boilerplate with our plugin ecosystem. + title: Plugin Ecosystem + details: Zod, TanStack Query, and 20+ plugins to reduce third-party boilerplate. link: /openapi-ts/core linkText: Explore plugins - icon: 🧩 - title: Custom - details: Build your own plugins and clients for proprietary use cases. + title: Custom Extensions + details: Build custom plugins for proprietary or advanced use cases. link: /openapi-ts/plugins/custom linkText: Build a custom plugin - icon: title: Integrations - details: Superpower your codegen with automations and integrations. + details: Sync specs, automate workflows, and integrate with the Hey API Platform. link: /openapi-ts/integrations linkText: Learn about integrations --- diff --git a/docs/openapi-ts/get-started.md b/docs/openapi-ts/get-started.md index da9cb4958..6a6f52e59 100644 --- a/docs/openapi-ts/get-started.md +++ b/docs/openapi-ts/get-started.md @@ -9,7 +9,9 @@ import { embedProject } from '../embed' # Get Started -[@hey-api/openapi-ts](https://github.com/hey-api/openapi-ts) is an [open source](/openapi-ts/license) OpenAPI to TypeScript code generator trusted by companies like Google, Amazon, and PayPal to generate API clients, SDKs, validators, and more. We also build complementary tools and [services](https://app.heyapi.dev/) that help teams design, manage, and distribute APIs more effectively. +[@hey-api/openapi-ts](https://github.com/hey-api/openapi-ts) generates TypeScript code from OpenAPI specifications. Point it at your spec, pick your plugins, and get production-ready code in seconds. + +Used by companies like Vercel, OpenCode, and PayPal. > _β€œOpenAPI codegen that just works.”_ > @@ -23,13 +25,14 @@ Launch demo ## Features -- runs in CLI, Node.js 20+, or npx -- works with OpenAPI 2.0, 3.0, and 3.1 -- core plugins for types, SDKs, and schemas -- clients for your runtime (Fetch API, Angular, Axios, Next.js, Nuxt, etc.) -- plugin ecosystem to reduce third-party boilerplate -- custom plugins and custom clients -- [integration](/openapi-ts/integrations) with Hey API Platform +- production-ready code that compiles +- runs in any Node.js 20+ environment +- accepts any OpenAPI specification +- core plugins for SDKs, types, and schemas +- HTTP clients for Fetch API, Angular, Axios, Next.js, Nuxt, and more +- 20+ plugins to reduce third-party boilerplate +- highly customizable via plugins +- [sync with Hey API Registry](/openapi-ts/integrations) for spec management ## Quick Start diff --git a/docs/partials/sponsors.md b/docs/partials/sponsors.md index 044732cdb..66fe7be82 100644 --- a/docs/partials/sponsors.md +++ b/docs/partials/sponsors.md @@ -1,6 +1,6 @@ ## Sponsors -Help Hey API stay around for the long haul by becoming a [sponsor](https://github.com/sponsors/hey-api). +Hey API is sponsor-funded. If your team relies on Hey API in production, consider becoming a [sponsor](https://github.com/sponsors/hey-api) to accelerate the roadmap.
diff --git a/packages/openapi-ts/README.md b/packages/openapi-ts/README.md index cc24166a1..6025bdc8d 100644 --- a/packages/openapi-ts/README.md +++ b/packages/openapi-ts/README.md @@ -14,7 +14,7 @@

Demo  β€’  - Docs + Manual  β€’  Issues  β€’  @@ -23,21 +23,22 @@ ## About -[@hey-api/openapi-ts](https://github.com/hey-api/openapi-ts) is an [open source](https://github.com/hey-api/openapi-ts/blob/main/LICENSE.md) OpenAPI to TypeScript code generator trusted by companies like Google, Amazon, and PayPal to generate API clients, SDKs, validators, and more. We also build complementary tools and [services](https://app.heyapi.dev/) that help teams design, manage, and distribute APIs more effectively. +The OpenAPI to TypeScript code generator used by Vercel, OpenCode, and PayPal. -## Features +Generate production-ready SDKs, Zod schemas, TanStack Query hooks, or choose from 20+ other plugins. -- runs in CLI, Node.js 20+, or npx -- works with OpenAPI 2.0, 3.0, and 3.1 -- core plugins for types, SDKs, and schemas -- clients for your runtime (Fetch API, Angular, Axios, Next.js, Nuxt, etc.) -- plugin ecosystem to reduce third-party boilerplate -- custom plugins and custom clients -- [integration](https://heyapi.dev/openapi-ts/integrations) with Hey API Platform +Part of the Hey API ecosystem. -## Dashboard +## Features -Access your projects and OpenAPI specifications in the [Hey API Platform](https://app.heyapi.dev/). +- production-ready code that compiles +- runs in any Node.js 20+ environment +- accepts any OpenAPI specification +- core plugins for SDKs, types, and schemas +- HTTP clients for Fetch API, Angular, Axios, Next.js, Nuxt, and more +- 20+ plugins to reduce third-party boilerplate +- highly customizable via plugins +- [sync with Hey API Registry](https://heyapi.dev/openapi-ts/integrations) for spec management ## Contributing @@ -47,7 +48,7 @@ Start with our [Contributing](https://heyapi.dev/openapi-ts/community/contributi ## Sponsors -Help Hey API stay around for the long haul by becoming a [sponsor](https://github.com/sponsors/hey-api). +Hey API is sponsor-funded. If your team relies on Hey API in production, consider becoming a [sponsor](https://github.com/sponsors/hey-api) to accelerate the roadmap.

Gold

diff --git a/packages/openapi-ts/package.json b/packages/openapi-ts/package.json index f9346c8ea..8b87fec22 100644 --- a/packages/openapi-ts/package.json +++ b/packages/openapi-ts/package.json @@ -1,7 +1,7 @@ { "name": "@hey-api/openapi-ts", "version": "0.89.2", - "description": "πŸŒ€ OpenAPI to TypeScript code generator. Generate API clients, SDKs, validators, and more.", + "description": "πŸŒ€ OpenAPI to TypeScript codegen. Production-ready SDKs, Zod schemas, TanStack Query hooks, and 20+ plugins. Used by Vercel, OpenCode, and PayPal.", "homepage": "https://heyapi.dev/", "repository": { "type": "git", -- 2.51.2