docs: add parser documentation

Author: mrlubos

.changeset/sour-dancers-draw.md

@@ -0,0 +1,42 @@
+---
+'@hey-api/openapi-ts': minor
+---
+
+feat(config): add `parser` options
+
+### Added `parser` options
+
+Previously, `@hey-api/typescript` would generate correct types, but the validator plugins would have to re-implement the same logic or generate schemas that didn't match the generated types.
+
+Since neither option was ideal, this release adds a dedicated place for `parser` options. Parser is responsible for preparing the input so plugins can generate more accurate output with less effort.
+
+You can learn more about configuring parser on the [Parser](https://heyapi.dev/openapi-ts/configuration/parser) page.
+
+### Moved `input` options
+
+The following options were moved to the new `parser` group.
+
+- `input.filters` moved to `parser.filters`
+- `input.pagination` moved to `parser.pagination`
+- `input.patch` moved to `parser.patch`
+- `input.validate_EXPERIMENTAL` moved to `parser.validate_EXPERIMENTAL`
+
+### Updated `typescript` options
+
+The following options were renamed.
+
+- `enumsCase` moved to `enums.case`
+- `enumsConstantsIgnoreNull` moved to `enums.constantsIgnoreNull`
+
+### Moved `typescript` options
+
+The following options were moved to the new `parser` group.
+
+- `exportInlineEnums` moved to `parser.transforms.enums`
+- `readOnlyWriteOnlyBehavior` moved to `parser.transforms.readWrite.enabled`
+- `readableNameBuilder` moved to `parser.transforms.readWrite.responses.name`
+- `writableNameBuilder` moved to `parser.transforms.readWrite.requests.name`
+
+### Updated `readWrite.responses` name
+
+Additionally, the naming pattern for response schemas has changed from `{name}Readable` to `{name}`. This is to prevent your code from breaking by default when using a schema that gets updated with a write-only field.

docs/.vitepress/config/en.ts

@@ -22,6 +22,21 @@ export default defineConfig({
             text: 'Get Started',
           },
           {
+            collapsed: true,
+            items: [
+              {
+                link: '/openapi-ts/configuration/input',
+                text: 'Input',
+              },
+              {
+                link: '/openapi-ts/configuration/output',
+                text: 'Output',
+              },
+              {
+                link: '/openapi-ts/configuration/parser',
+                text: 'Parser',
+              },
+            ],
             link: '/openapi-ts/configuration',
             text: 'Configuration',
           },

docs/.vitepress/theme/Layout.vue

@@ -8,7 +8,7 @@ const { Layout } = DefaultTheme;
   <Layout>
     <template #layout-top>
       <div class="announcement">
-        <span> Build better APIs with our platform </span>
+        <span> Build better APIs with Hey API Platform </span>
         <a
           href="https://app.heyapi.dev/"
           rel="noopener noreferrer"