Merge pull request #1496 from hey-api/docs/output-section

docs: split output section into multiple pages
hey-api · Dec 20, 2024 · 328dd4b · 328dd4b
2 parents c48c446 + 1e418ba
commit 328dd4b
Show file tree

Hide file tree

Showing 43 changed files with 440 additions and 400 deletions.
diff --git a/.changeset/orange-squids-press.md b/.changeset/orange-squids-press.md
@@ -0,0 +1,5 @@
+---
+'@hey-api/docs': patch
+---
+
+docs: split output section into multiple pages
diff --git a/docs/.vitepress/config/en.ts b/docs/.vitepress/config/en.ts
@@ -31,6 +31,21 @@ export default defineConfig({
       {
         items: [
           {
+            collapsed: true,
+            items: [
+              {
+                link: '/openapi-ts/output/typescript',
+                text: 'TypeScript',
+              },
+              {
+                link: '/openapi-ts/output/sdk',
+                text: 'SDK',
+              },
+              {
+                link: '/openapi-ts/output/json-schema',
+                text: 'JSON Schema',
+              },
+            ],
             link: '/openapi-ts/output',
             text: 'Output',
           },
@@ -210,6 +225,10 @@ export default defineConfig({
             link: '/contributing',
             text: 'Contributing',
           },
+          {
+            link: 'https://github.com/orgs/hey-api/discussions/1495',
+            text: 'Roadmap',
+          },
         ],
         text: '@hey-api',
       },

diff --git a/docs/about.md b/docs/about.md
@@ -48,4 +48,4 @@ These are the people with significant contributions to Hey API. A special thank
 
 <VPTeamMembers size="small" :members="hallOfFame" />
 
-<!--@include: ./sponsorship.md-->
+<!--@include: ./sponsors.md-->
diff --git a/docs/index.md b/docs/index.md
@@ -11,6 +11,9 @@ hero:
     - theme: alt
       text: View Demo
       link: https://stackblitz.com/edit/hey-api-example?file=openapi-ts.config.ts,src%2Fclient%2Fschemas.gen.ts,src%2Fclient%2Fsdk.gen.ts,src%2Fclient%2Ftypes.gen.ts
+    - theme: alt
+      text: Roadmap
+      link: https://github.com/orgs/hey-api/discussions/1495
   image:
     src: /logo.png
     alt: logo

diff --git a/docs/openapi-ts/clients.md b/docs/openapi-ts/clients.md
@@ -33,4 +33,4 @@ Hey API natively supports the following clients.
 Don't see your client? Let us know your interest by [opening an issue](https://github.com/hey-api/openapi-ts/issues).
 
 <!--@include: ../examples.md-->
-<!--@include: ../sponsorship.md-->
+<!--@include: ../sponsors.md-->
diff --git a/docs/openapi-ts/clients/axios.md b/docs/openapi-ts/clients/axios.md
@@ -187,4 +187,4 @@ export default {
 ```
 
 <!--@include: ../../examples.md-->
-<!--@include: ../../sponsorship.md-->
+<!--@include: ../../sponsors.md-->
diff --git a/docs/openapi-ts/clients/fetch.md b/docs/openapi-ts/clients/fetch.md
@@ -226,4 +226,4 @@ export default {
 ```
 
 <!--@include: ../../examples.md-->
-<!--@include: ../../sponsorship.md-->
+<!--@include: ../../sponsors.md-->
diff --git a/docs/openapi-ts/clients/legacy.md b/docs/openapi-ts/clients/legacy.md
@@ -129,4 +129,4 @@ Angular client does not currently support request interceptors.
 :::
 
 <!--@include: ../../examples.md-->
-<!--@include: ../../sponsorship.md-->
+<!--@include: ../../sponsors.md-->
diff --git a/docs/openapi-ts/configuration.md b/docs/openapi-ts/configuration.md
@@ -278,4 +278,4 @@ Setting `output.clean` to `false` may result in broken output. Ensure you typech
 You can view the complete list of options in the [UserConfig](https://github.com/hey-api/openapi-ts/blob/main/packages/openapi-ts/src/types/config.ts) interface.
 
 <!--@include: ../examples.md-->
-<!--@include: ../sponsorship.md-->
+<!--@include: ../sponsors.md-->
diff --git a/docs/openapi-ts/custom-plugin.md b/docs/openapi-ts/custom-plugin.md
@@ -197,4 +197,4 @@ export const foo = 'Hello, world!';
 Congratulations! You've successfully created your own plugin! :tada:
 
 <!--@include: ../examples.md-->
-<!--@include: ../sponsorship.md-->
+<!--@include: ../sponsors.md-->
diff --git a/docs/openapi-ts/get-started.md b/docs/openapi-ts/get-started.md
@@ -13,7 +13,7 @@ import { embedProject } from '../embed'
 This package is in initial 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).
 :::
 
-[@hey-api/openapi-ts](https://github.com/hey-api/openapi-ts) is an OpenAPI to TypeScript codegen trusted more than 700k times each month to generate reliable API clients and SDKs.
+[@hey-api/openapi-ts](https://github.com/hey-api/openapi-ts) is an OpenAPI to TypeScript codegen trusted more than 700k times each month to generate reliable API clients and SDKs. The code is [MIT-licensed](/license) and free to use. Discover available features below or view our [roadmap](https://github.com/orgs/hey-api/discussions/1495) to learn what's coming next.
 
 <button class="buttonLink" @click="(event) => embedProject('hey-api-example')(event)">
 Live demo
@@ -99,4 +99,4 @@ createClient({
 It is a good practice to extract your configuration into a separate file. Learn how to do that and discover available options on the [Configuration](/openapi-ts/configuration) page.
 
 <!--@include: ../examples.md-->
-<!--@include: ../sponsorship.md-->
+<!--@include: ../sponsors.md-->
diff --git a/docs/openapi-ts/mocks.md b/docs/openapi-ts/mocks.md
@@ -19,4 +19,4 @@ Hey API natively supports the following mocking frameworks.
 Don't see your framework? Let us know your interest by [opening an issue](https://github.com/hey-api/openapi-ts/issues).
 
 <!--@include: ../examples.md-->
-<!--@include: ../sponsorship.md-->
+<!--@include: ../sponsors.md-->
Original file line number	Diff line number	Diff line change
Expand Up		@@ -48,4 +48,4 @@ These are the people with significant contributions to Hey API. A special thank

		<VPTeamMembers size="small" :members="hallOfFame" />

		<!--@include: ./sponsorship.md-->
		<!--@include: ./sponsors.md-->