diff --git a/.changeset/new-apples-suffer.md b/.changeset/new-apples-suffer.md
new file mode 100644
index 000000000..6d8dc2729
--- /dev/null
+++ b/.changeset/new-apples-suffer.md
@@ -0,0 +1,5 @@
+---
+'@hey-api/docs': patch
+---
+
+docs: add Zod plugin page
diff --git a/README.md b/README.md
index baf20b1ba..d5a5aa962 100644
--- a/README.md
+++ b/README.md
@@ -13,6 +13,7 @@
- supports both JSON and YAML input files
- generates TypeScript interfaces, REST clients, and JSON Schemas
- Fetch API, Axios, Angular, Node.js, and XHR clients available
+- plugin ecosystem to reduce third-party boilerplate
## Documentation
diff --git a/docs/.vitepress/config/en.ts b/docs/.vitepress/config/en.ts
index 9675a4e91..53e7caccb 100644
--- a/docs/.vitepress/config/en.ts
+++ b/docs/.vitepress/config/en.ts
@@ -5,6 +5,12 @@ export default defineConfig({
'🚀 The OpenAPI to TypeScript codegen. Generate clients, SDKs, validators, and more.',
lang: 'en-US',
themeConfig: {
+ nav: [
+ {
+ link: 'https://github.com/sponsors/mrlubos',
+ text: 'Sponsor Hey API',
+ },
+ ],
sidebar: [
{
items: [
@@ -36,28 +42,37 @@ export default defineConfig({
text: 'Clients',
},
{ link: '/openapi-ts/transformers', text: 'Transformers' },
- { link: '/openapi-ts/migrating', text: 'Migrating' },
],
text: 'Guides and Concepts',
},
{
items: [
- {
- link: '/openapi-ts/integrations',
- text: 'Integrations soon',
- },
{
link: '/openapi-ts/tanstack-query',
text: 'TanStack Query',
},
+ {
+ link: '/openapi-ts/zod',
+ text: 'Zod soon',
+ },
],
text: 'Plugins',
},
+ {
+ items: [
+ {
+ link: '/openapi-ts/integrations',
+ text: 'GitHub soon',
+ },
+ ],
+ text: 'Integrations',
+ },
{
items: [
{ link: '/about', text: 'Philosophy' },
{ link: '/license', text: 'License' },
{ link: '/contributing', text: 'Contributing' },
+ { link: '/openapi-ts/migrating', text: 'Migrating' },
],
text: '@hey-api',
},
diff --git a/docs/about.md b/docs/about.md
index a39290e68..5134dc865 100644
--- a/docs/about.md
+++ b/docs/about.md
@@ -13,15 +13,23 @@ const hallOfFame = [
links: [
{ icon: 'github', link: 'https://github.com/ferdikoomen' },
],
- title: 'Author of OpenAPI TypeScript Codegen',
+ title: 'OpenAPI TypeScript Codegen',
+ },
+ {
+ avatar: 'https://github.com/nicolas-chaulet.png',
+ name: 'Nicolas Chaulet',
+ links: [
+ { icon: 'github', link: 'https://github.com/nicolas-chaulet' },
+ ],
+ title: 'Made the Hey API fork',
},
{
avatar: 'https://github.com/jordanshatford.png',
- name: 'Jordan',
+ name: 'Jordan Shatford',
links: [
{ icon: 'github', link: 'https://github.com/jordanshatford' },
],
- title: 'Maintainer',
+ title: 'Maintainer and Contributor',
},
]
diff --git a/docs/contributing.md b/docs/contributing.md
index 59132f0c1..19ec3917e 100644
--- a/docs/contributing.md
+++ b/docs/contributing.md
@@ -7,40 +7,17 @@ description: Learn how to contribute to Hey API.
Thank you for considering contributing to Hey API. In order to increase the likelihood of your changes being merged, first open an issue if one does not already exist. Once an issue exists, let us know you'd like to work on it. We will confirm whether we're looking to resolve the issue and provide you with guidance if required. This is to ensure our codebase remains in good state and all features contribute to Hey API's [objectives](/about).
-## Development Requirements
+## Prerequisites
-- [git](https://git-scm.com/)
-- [node](https://nodejs.org/en) (version `18.0` or higher)
-- [pnpm](https://pnpm.io/) (version `8` or higher)
+You should have a working knowledge of [git](https://git-scm.com/), [node](https://nodejs.org/en), and [pnpm](https://pnpm.io/).
-## Install Dependencies
+## Guidelines
-We use pnpm as our package manager. You can setup and install all dependencies running the following command:
+Your [pull request](https://help.github.com/articles/using-pull-requests) must:
-```sh
-pnpm install
-```
+- address a single issue or add a single item of functionality
+- contain a clean history of small, incremental, logically separate commits, with no merge commits
+- use clear commit messages
+- be possible to merge automatically
-## Pull Request Guidelines
-
-If you are unfamiliar with GitHub Pull Requests, please read the following documentation:
-https://help.github.com/articles/using-pull-requests
-
-**Your Pull Request must:**
-
-- Address a single issue or add a single item of functionality.
-- Contain a clean history of small, incremental, logically separate commits, with no merge commits.
-- Use clear commit messages.
-- Be possible to merge automatically.
-
-## Submitting a Pull Request
-
-1. Make your changes in a new git branch: `git checkout -b my-fix-branch main`
-1. Create your patch or feature
-1. Ensure the builds work by running: `pnpm build`
-1. Ensure the tests will pass by running: `pnpm test`
-1. Ensure the code is formatted by running: `pnpm lint:fix`
-1. Ensure that you create a changeset if required by running: `pnpm changeset`
-1. Commit your changes using a descriptive commit message
-
-After your Pull Request is created, it will automatically be built and tested in GitHub actions. Once successful, it will be ready for review.
+
diff --git a/docs/index.md b/docs/index.md
index ca0f0cf6d..fe64f186b 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -3,7 +3,7 @@ layout: home
hero:
name: High-quality tools for interacting with APIs
- tagline: Abstractions for your TypeScript code. Automate type generation and type-safe data fetching.
+ tagline: Codegen for your TypeScript projects. Trusted more than 500k times each month to generate reliable API clients and SDKs.
actions:
- theme: brand
text: Get Started
@@ -22,7 +22,7 @@ features:
link: /openapi-ts/get-started
linkText: Get started
- icon:
- title: TypeScript Interfaces
+ title: Type Safety
details: Ensure code correctness without runtime overhead. No manual maintenance required.
link: /openapi-ts/output
linkText: Learn more
@@ -36,16 +36,16 @@ features:
details: Export OpenAPI schemas as JavaScript objects. JSON Schema 2020-12 supported.
link: /openapi-ts/output#json-schemas
linkText: Learn more
+ - icon:
+ title: Plugins
+ details: Reduce third-party boilerplate with our plugin ecosystem.
+ link: /openapi-ts/tanstack-query
+ linkText: Learn more
- icon:
- title: GitHub Integration Soon
+ title: Integrations Soon
details: Automatically update your code when the APIs it depends on change. Works with any codegen.
link: /openapi-ts/integrations
linkText: Find out more
- - icon:
- title: TanStack Query
- details: Generate query keys and functions. Use them with our REST clients or bring your own.
- link: /openapi-ts/tanstack-query
- linkText: Find out more
---
### Migrating from OpenAPI Typescript Codegen?
diff --git a/docs/openapi-ts/clients.md b/docs/openapi-ts/clients.md
index d269a46d9..ff13c0040 100644
--- a/docs/openapi-ts/clients.md
+++ b/docs/openapi-ts/clients.md
@@ -1,6 +1,6 @@
---
title: Clients
-description: REST clients for your stack. Compatible with all our features.
+description: REST clients for Hey API. Compatible with all our features.
---