Merge pull request #1891 from hey-api/docs/custom-client

docs: add custom client page

Author: mrlubos

docs/.vitepress/config/en.ts

@@ -53,7 +53,7 @@ export default defineConfig({
             collapsed: true,
             items: [
               {
-                link: '/openapi-ts/custom-plugin',
+                link: '/openapi-ts/plugins/custom',
                 text: 'Custom Plugin',
               },
             ],
@@ -79,6 +79,10 @@ export default defineConfig({
                 link: '/openapi-ts/clients/nuxt',
                 text: 'Nuxt',
               },
+              {
+                link: '/openapi-ts/clients/custom',
+                text: 'Custom Client',
+              },
               {
                 link: '/openapi-ts/clients/legacy',
                 text: 'Legacy',

docs/openapi-ts/clients/custom.md

@@ -0,0 +1,19 @@
+---
+title: Custom Client
+description: Learn how to create your own Hey API client.
+---
+
+# Custom Client
+
+::: warning
+Client API is in development. The interface might change before it becomes stable. We encourage you to leave feedback on [GitHub](https://github.com/hey-api/openapi-ts/issues/1213).
+:::
+
+You may need to write your own client if the available clients do not suit your needs or you're working on a proprietary use case. This can be easily achieved using the Client API. But don't take our word for it – all Hey API clients are written this way!
+
+::: warning
+Custom clients documentation will be finalized after further testing. Simplified [instructions](https://github.com/hey-api/openapi-ts/issues/1213#issuecomment-2765206344) can be found in the GitHub thread.
+:::
+
+<!--@include: ../../examples.md-->
+<!--@include: ../../sponsors.md-->

docs/openapi-ts/custom-plugin.md renamed to docs/openapi-ts/plugins/custom.md

@@ -192,5 +192,5 @@ export const foo = 'Hello, world!';
 
 Congratulations! You've successfully created your own plugin! :tada:
 
-<!--@include: ../examples.md-->
-<!--@include: ../sponsors.md-->
+<!--@include: ../../examples.md-->
+<!--@include: ../../sponsors.md-->

docs/vercel.json

@@ -9,6 +9,11 @@
       "source": "/openapi-ts",
       "destination": "/openapi-ts/get-started",
       "permanent": true
+    },
+    {
+      "source": "/openapi-ts/custom-plugin",
+      "destination": "/openapi-ts/plugins/custom",
+      "permanent": true
     }
   ],
   "trailingSlash": false