docs: minor updates

Julien-R44 · Oct 15, 2024 · 272a8cb · 272a8cb
1 parent 1f81c14
commit 272a8cb
Show file tree

Hide file tree

Showing 4 changed files with 22 additions and 5 deletions.
diff --git a/docs/content/docs/client.md b/docs/content/docs/client.md
@@ -4,10 +4,14 @@ summary: How to use Tuyau RPC / E2E Client in your AdonisJS project
 
 # Client
 
-As mentioned in the [installation](./installation.md), we used `createTuyau` to create our client instance. This instance will be used to make requests to our API. The following options are available:
+As mentioned in the [installation](./installation.md), we used `createTuyau` to create our client instance in our frontend application. This instance will be used to make requests to our API, and it will also provide some helpers to generate URLs, check the current route, etc.
+
+Tuyau client is built on top of [Ky](https://github.com/sindresorhus/ky).
 
 ## Options
 
+The `createTuyau` function accepts an object with the following options:
+
 ### `api`
 
 The `api` object is the generated API definition from your AdonisJS project. This object contains everything needed for Tuyau to work. It contains the routes, the types, the definitions, etc.
@@ -38,7 +42,12 @@ export const tuyau = createTuyau<{ definition: ApiDefinition }>({
 })
 ```
 
-To clarify, if you don't need to use methods like `tuyau.$url('users.posts.show', { id: 1, postId: 2 })`, `$tuyau.route`, or the `Link` component from `@tuyau/inertia`, you can ignore the `api` object and only pass the `ApiDefinition` type to `createTuyau`.
+To clarify, if you don't need to use methods like :
+- `tuyau.$url('users.posts.show', { id: 1, postId: 2 })`
+- `$tuyau.route(...)`,
+- or the `<Link>` component from `@tuyau/inertia`
+
+You can ignore the `api` object and only pass the `ApiDefinition` type to `createTuyau`.
 
 ### `baseUrl`
 

diff --git a/docs/content/docs/db.json b/docs/content/docs/db.json
@@ -12,19 +12,19 @@
     "category": "Guides"
   },
   {
-    "permalink": "Client",
+    "permalink": "client",
     "title": "Client",
     "contentPath": "./client.md",
     "category": "Guides"
   },
   {
-    "permalink": "Inertia",
+    "permalink": "inertia",
     "title": "Inertia",
     "contentPath": "./inertia.md",
     "category": "Guides"
   },
   {
-    "permalink": "OpenAPI",
+    "permalink": "openapi",
     "title": "OpenAPI",
     "contentPath": "./openapi.md",
     "category": "Guides"

diff --git a/docs/content/docs/inertia.md b/docs/content/docs/inertia.md
@@ -1,3 +1,7 @@
+---
+summary: Inertia helpers for AdonisJS, Ziggy-like API for you frontend application.
+---
+
 # Inertia package
 
 Tuyau also provides a set of helpers for Inertia projects. The package is called `@tuyau/inertia`. First, make sure to have generated the API definition in your AdonisJS project using `@tuyau/core` and also have configured the client in your frontend project using `@tuyau/client`.

diff --git a/docs/content/docs/introduction.md b/docs/content/docs/introduction.md
@@ -1,3 +1,7 @@
+---
+summary: A set of tools to create typesafe APIs with AdonisJS, including an E2E client like tRPC, Inertia helpers, Ziggy-like and more.
+---
+
 # Introduction
 
 ![](https://static.julr.dev/tuyau.png)