update documentation

.vitepress/config.mts

@@ -2,7 +2,7 @@ import { defineConfig, type DefaultTheme } from 'vitepress'
 
 export default defineConfig({
   title: "WebhookX",
-  description: "A modern webhooks gateway.",
+  description: "The Next-Generation Webhooks Gateway.",
   cleanUrls: true,
   srcExclude: [
     "README.md"
@@ -14,7 +14,6 @@ export default defineConfig({
     outline: {
       level: [2, 3],
     },
-
     nav: [
       {
         text: 'Documentation',
@@ -49,27 +48,28 @@ function sidebarDocs(): DefaultTheme.SidebarItem[] {
       text: "Home",
       items: [
         { text: 'Overview', link: 'docs/index' },
+        { text: 'Architecture', link: 'docs/architecture' },
       ]
     },
     {
-      text: "Install",
-      link: 'docs/install/index',
+      text: "Quickstart",
       items: [
-        { text: 'WebhookX', link: 'docs/install/index' },
-      ]
-    },
-    {
-      text: "Deployment",
-      collapsed: false,
-      items: [
-        { text: 'Configuration', link: 'docs/configuration' },
+        { text: 'Docker', link: 'docs/quickstart/docker' },
+        { text: 'Kubernetes', link: 'docs/quickstart/kubernetes' },
+        { text: 'Others', link: 'docs/quickstart/others' },
       ]
     },
+    // {
+    //   text: "Deployment",
+    //   items: [
+    //
+    //   ]
+    // },
     {
       text: "Admin API",
-      collapsed: false,
+      link: 'docs/admin/overview',
       items: [
-        { text: 'Overview', link: 'docs/admin/overview' },
+        { text: 'Entities', link: 'docs/admin/entities' },
       ]
     },
     {
@@ -91,11 +91,22 @@ function sidebarDocs(): DefaultTheme.SidebarItem[] {
         },
       ]
     },
+    {
+      text: "Best Practice",
+      link: 'docs/best-practice/best-practice',
+    },
+    {
+      text: "Performance",
+      items: [
+        { text: 'Benchmarks', link: 'docs/benchmarks' },
+      ]
+    },
     {
       text: "References",
       items: [
+        { text: 'Configuration', link: 'docs/configuration' },
         { text: 'CLI', link: 'docs/cli' },
-        { text: 'API Reference', link: 'https://webhookx.mintlify.app/api-reference/' },
+        { text: 'API Reference', link: 'https://openapi.webhookx.io/' },
         { text: 'Release Notes', link: 'https://github.com/webhookx-io/webhookx/releases' },
       ]
     },

docs/admin/entities.md

@@ -0,0 +1,14 @@
+# WebhookX entities
+
+
+## Endpoints
+
+## Sources
+
+## Plugins
+
+## Workspaces
+
+## Attempts
+
+## Events

docs/architecture.md

@@ -0,0 +1,32 @@
+# Architecture
+
+WebhookX is consists of three components, which are Admin, Proxy, and Worker. 
+
+![architecture.png](/public/images/architecture.png)
+
+
+### Components
+
+#### Admin
+
+Admin expose a RESTful API on port `:8080` for managing WebhookX entities.
+
+
+#### Proxy
+
+Proxy expose an HTTP server for receiving events.
+
+
+#### Worker
+
+Worker deliveries events to endpoints.
+
+
+## Runtime Dependencies
+
+WebhookX requires the following dependencies to work
+
+- PostgreSQL 13+
+
+
+- Redis 6.2+

docs/benchmarks.md

@@ -0,0 +1,5 @@
+# Benchmarks
+
+
+
+Work in Progress

docs/best-practice/best-practice.md

@@ -0,0 +1,14 @@
+# Best Practices
+
+
+
+## Deployment
+
+
+## Send Event
+
+
+## Receive Event
+
+
+

docs/cli.md

@@ -10,14 +10,16 @@ Usage:
   webhookx [command]
 
 Available Commands:
+  admin       Admin commands
   completion  Generate the autocompletion script for the specified shell
   help        Help about any command
   migrations  
   start       Start server
   version     Print the version
 
 Flags:
-  -h, --help   help for webhookx
+  -h, --help      help for webhookx
+      --verbose   Verbose logging.
 
 Use "webhookx [command] --help" for more information about a command.
 ```
@@ -28,11 +30,32 @@ Use "webhookx [command] --help" for more information about a command.
 
 All commands take a set of special, optional flags as arguments:
 
--   `-h`, `--help`: print the command’s help message
+- `-h`, `--help`: print the command’s help message
+- `--verbose`: enable verbose logging.
 
 ## Commands
 
+### webhookx admin
 
+```sh
+webhookx admin --help
+Admin commands
+
+Usage:
+  webhookx admin [command]
+
+Available Commands:
+  dump        Dump entities to declarative configuration
+  sync        Synchronize a declarative configuration to WebhookX.
+
+Flags:
+  -h, --help   help for admin
+
+Global Flags:
+      --verbose   Verbose logging.
+
+Use "webhookx admin [command] --help" for more information about a command.
+```
 
 ### webhookx migrations
 
@@ -73,7 +96,7 @@ Flags:
 
 
 
-#### webhookx version
+### webhookx version
 
 ```sh
 $ webhookx version --help