docs: update

phk422 · phk422 · commit 3ca8e9430dcf · 2024-07-16T17:00:15.000+08:00
diff --git a/docs/openapi-fetch/index.md b/docs/openapi-fetch/index.md
@@ -44,7 +44,7 @@ await client.PUT("/blogposts", {
 
 :::
 
-`data` and `error` are typechecked and expose their shapes to Intellisence in VS Code (and any other IDE with TypeScript support). Likewise, the request `body` will also typecheck its fields, erring if any required params are missing, or if there’s a type mismatch.
+`data` and `error` are typechecked and expose their shapes to Intellisense in VS Code (and any other IDE with TypeScript support). Likewise, the request `body` will also typecheck its fields, erring if any required params are missing, or if there’s a type mismatch.
 
 `GET()`, `PUT()`, `POST()`, etc. are thin wrappers around the native [fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API) (which you can [swap for any call](/openapi-fetch/api#create-client)).
 
diff --git a/packages/openapi-fetch/README.md b/packages/openapi-fetch/README.md
@@ -14,7 +14,7 @@ _\* [Benchmarks are approximate](https://github.com/openapi-ts/openapi-typescrip
 
 The syntax is inspired by popular libraries like react-query or Apollo client, but without all the bells and whistles and in a 5 kb package.
 
-```ts [src/my-project.ts]
+```ts
 import createClient from "openapi-fetch";
 import type { paths } from "./my-openapi-3-schema"; // generated by openapi-typescript
 
@@ -36,9 +36,9 @@ await client.PUT("/blogposts", {
 });
 ```
 
-`data` and `error` are typechecked and expose their shapes to Intellisence in VS Code (and any other IDE with TypeScript support). Likewise, the request `body` will also typecheck its fields, erring if any required params are missing, or if there’s a type mismatch.
+`data` and `error` are typechecked and expose their shapes to Intellisense in VS Code (and any other IDE with TypeScript support). Likewise, the request `body` will also typecheck its fields, erring if any required params are missing, or if there’s a type mismatch.
 
-`GET()`, `PUT()`, `POST()`, etc. are thin wrappers around the native [fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API) (which you can [swap for any call](/openapi-fetch/api#create-client)).
+`GET()`, `PUT()`, `POST()`, etc. are thin wrappers around the native [fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API) (which you can [swap for any call](https://openapi-ts.dev/openapi-fetch/api/#create-client)).
 
 Notice there are no generics, and no manual typing. Your endpoint’s request and response were inferred automatically. This is a huge improvement in the type safety of your endpoints because **every manual assertion could lead to a bug**! This eliminates all of the following:
 
@@ -51,14 +51,13 @@ Notice there are no generics, and no manual typing. Your endpoint’s request an
 
 ## Setup
 
-Install this library along with [openapi-typescript](/introduction):
+Install this library along with [openapi-typescript](../openapi-typescript):
 
 ```bash
 npm i openapi-fetch
 npm i -D openapi-typescript typescript
 ```
 
-> **TIP:**
 > **Highly recommended**
 > 
 > Enable [noUncheckedIndexedAccess](https://www.typescriptlang.org/tsconfig#noUncheckedIndexedAccess) in your `tsconfig.json` ([docs](/advanced#enable-nouncheckedindexaccess-in-your-tsconfigjson))
@@ -71,7 +70,7 @@ npx openapi-typescript ./path/to/api/v1.yaml -o ./src/lib/api/v1.d.ts
 
 Lastly, be sure to **run typechecking** in your project. This can be done by adding `tsc --noEmit` to your [npm scripts](https://docs.npmjs.com/cli/v9/using-npm/scripts) like so:
 
-```json [package.json]
+```json
 {
   "scripts": {
     "test:ts": "tsc --noEmit"
@@ -91,7 +90,7 @@ The best part about using openapi-fetch over oldschool codegen is no documentati
 
 ![OpenAPI schema example](../../docs/public/assets/openapi-schema.png)
 
-```ts [src/my-project.ts]
+```ts
 import createClient from "openapi-fetch";
 import type { paths } from "./my-openapi-3-schema"; // generated by openapi-typescript
 
@@ -117,43 +116,6 @@ const { data, error } = await client.PUT("/blogposts", {
 2. You pass in your desired `path` to `GET()`, `PUT()`, etc.
 3. TypeScript takes over the rest and returns helpful errors for anything missing or invalid
 
-### Pathname
-
-The pathname of `GET()`, `PUT()`, `POST()`, etc. **must match your schema literally.** Note in the example, the URL is `/blogposts/{post_id}`. This library will quickly replace all `path` params for you (so they can be typechecked).
-
-
-> **TIP:**
-> 
-> openapi-fetch infers types from the URL. Prefer static string values over dynamic runtime values, e.g.:
-> - ✅ `"/blogposts/{post_id}"`
-> - ❌ `[...pathParts].join("/") + "{post_id}"`
-
-This library also supports the **label** and **matrix** serialization styles as well ([docs](https://swagger.io/docs/specification/serialization/#path)) automatically.
-
-### Request
-
-The `GET()` request shown needed the `params` object that groups [parameters by type](https://spec.openapis.org/oas/latest.html#parameter-object) (`path` or `query`). If a required param is missing, or the wrong type, a type error will be thrown.
-
-The `POST()` request required a `body` object that provided all necessary [requestBody](https://spec.openapis.org/oas/latest.html#request-body-object) data.
-
-### Response
-
-All methods return an object with **data**, **error**, and **response**.
-
-```ts
-const { data, error, response } = await client.GET("/url");
-```
-
-| Object     | Response                                                                                                                    |
-| :--------- | :-------------------------------------------------------------------------------------------------------------------------- |
-| `data`     | `2xx` response if OK; otherwise `undefined`                                                                                 |
-| `error`    | `5xx`, `4xx`, or `default` response if not OK; otherwise `undefined`                                                        |
-| `response` | [The original Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) which contains `status`, `headers`, etc. |
-
-## Support
+## 📓 Docs
 
-| Platform       | Support                                                                                                                                            |
-| :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------- |
-| **Browsers**   | [See fetch API support](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API#browser_compatibility) (widely-available in all major browsers) |
-| **Node**       | >= 18.0.0                                                                                                                                          |
-| **TypeScript** | >= 4.7 (>= 5.0 recommended)                                                                                                                        |
+[View Docs](https://openapi-ts.dev/openapi-fetch/)
diff --git a/packages/openapi-typescript/README.md b/packages/openapi-typescript/README.md
@@ -2,7 +2,7 @@
 
 openapi-typescript turns [OpenAPI 3.0 & 3.1](https://spec.openapis.org/oas/latest.html) schemas into TypeScript quickly using Node.js. No Java/node-gyp/running OpenAPI servers necessary.
 
-The code is [MIT-licensed](https://github.com/openapi-ts/openapi-typescript/blob/main/packages/openapi-typescript/LICENSE") and free for use.
+The code is [MIT-licensed](./LICENSE) and free for use.
 
 > **Tip:**
 > New to OpenAPI? Speakeasy’s [Intro to OpenAPI](https://www.speakeasyapi.dev/openapi) is an accessible guide to newcomers that explains the “why” and “how” of OpenAPI.
@@ -18,7 +18,7 @@ _Note: OpenAPI 2.x is supported with versions `5.x` and previous_
 
 ## Examples
 
-👀 [See examples](https://github.com/openapi-ts/openapi-typescript/blob/main/packages/openapi-typescript/examples/)
+👀 [See examples](./examples/)
 
 ## Setup
 
@@ -30,7 +30,7 @@ npm i -D openapi-typescript typescript
 
 And in your `tsconfig.json`, to load the types properly:
 
-```diff [tsconfig.json]
+```diff
 {
   "compilerOptions": {
 +    "module": "ESNext", // or "NodeNext"
@@ -39,11 +39,10 @@ And in your `tsconfig.json`, to load the types properly:
 }
 ```
 
-> **Tip:**
 > **Highly recommended**
 > 
 > Also adding the following can boost type safety:
-> ```diff [tsconfig.json]
+> ```diff
 > {
 >   "compilerOptions": {
 > +    "noUncheckedIndexedAccess": true
@@ -67,7 +66,7 @@ npx openapi-typescript https://myapi.dev/api/v1/openapi.yaml -o ./path/to/my/sch
 
 Then in your TypeScript project, import types where needed:
 
-```ts [src/my-project.ts]
+```ts
 import type { paths, components } from "./my-openapi-3-schema"; // generated by openapi-typescript
 
 // Schema Obj
@@ -85,8 +84,12 @@ type ErrorResponse =
 
 From here, you can use these types for any of the following (but not limited to):
 
-- Using an OpenAPI-supported fetch client (like [openapi-fetch](/openapi-fetch/))
+- Using an OpenAPI-supported fetch client (like [openapi-fetch](https://openapi-ts.dev/openapi-fetch/))
 - Asserting types for other API requestBodies and responses
 - Building core business logic based on API types
 - Validating mock test data is up-to-date with the current schema
 - Packaging API types into any npm packages you publish (such as client SDKs, etc.)
+
+## 📓 Docs
+
+[View Docs](https://openapi-ts.dev/)
