diff --git a/.vitepress/config.mts b/.vitepress/config.mts index 02cc210..cee96ea 100644 --- a/.vitepress/config.mts +++ b/.vitepress/config.mts @@ -13,9 +13,9 @@ export default defineConfig({ nav: [ { - text: 'Docs', - link: '/docs', - activeMatch: '/' + text: 'Documentation', + link: '/docs/index', + activeMatch: '/docs' }, { text: 'Blog', @@ -25,7 +25,7 @@ export default defineConfig({ ], sidebar: { - '/': { base: '/', items: sidebarDocs() }, + '/docs/': { base: '', items: sidebarDocs() }, '/blog/': { base: '/blog/', items: sidebarBlog() } }, @@ -42,41 +42,38 @@ export default defineConfig({ function sidebarDocs(): DefaultTheme.SidebarItem[] { return [ { - text: "Introduction", - collapsed: false, + text: "Home", items: [ - { text: 'Overview', link: 'introduction/overview' }, - { text: 'CLI', link: 'docs/cli' }, + { text: 'Overview', link: 'docs/index' }, ] }, { text: "Install WebhookX", - collapsed: true, + collapsed: false, items: [ - { text: 'Docker', link: 'install/docker' }, - // { text: 'Kubernetes', link: 'install/kubernetes' }, - // { text: 'Linux', link: 'install/linux' }, + { text: 'Docker', link: 'docs/install/docker' }, ] }, { text: "Deployment", collapsed: false, items: [ - { text: 'Configuration', link: 'configuration' }, + { text: 'Configuration', link: 'docs/configuration' }, ] }, { text: "Admin API", collapsed: false, items: [ - { text: 'Overview', link: 'admin/overview' }, + { text: 'Overview', link: 'docs/admin/overview' }, ] }, { - text: "Others", - collapsed: false, + text: "References", items: [ - { text: 'Release Notes', link: 'https://github.com/webhookx-io/webhookx/releases/' } + { text: 'CLI', link: 'docs/cli' }, + { text: 'OpenAPI', link: 'https://github.com/webhookx-io/webhookx/blob/main/openapi.yml' }, + { text: 'Release Notes', link: 'https://github.com/webhookx-io/webhookx/releases' }, ] }, ] diff --git a/blog/index.md b/blog/index.md index 5e55f02..3aec35f 100644 --- a/blog/index.md +++ b/blog/index.md @@ -1,6 +1,3 @@ # Posts - -- Post 1 -- Post 2 -- Post 3 \ No newline at end of file +👋 Coming soon... diff --git a/docs-index.md b/docs-index.md deleted file mode 100644 index e69de29..0000000 diff --git a/admin/overview.md b/docs/admin/overview.md similarity index 100% rename from admin/overview.md rename to docs/admin/overview.md diff --git a/configuration.md b/docs/configuration.md similarity index 100% rename from configuration.md rename to docs/configuration.md diff --git a/docs/index.md b/docs/index.md index 7d8b3af..6a99430 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1 +1,5 @@ -# Documentation \ No newline at end of file +# Documentation + +WebhookX is an open-source webhooks gateway for message receiving, processing, and delivering. + +👋Coming soon... diff --git a/install/docker.md b/docs/install/docker.md similarity index 81% rename from install/docker.md rename to docs/install/docker.md index 53abd04..b9a455d 100644 --- a/install/docker.md +++ b/docs/install/docker.md @@ -9,7 +9,7 @@ ```yaml services: webhookx-migration: - image: "webhookx-io/webhookx:latest" + image: "webhookx/webhookx:latest" container_name: webhookx-migration environment: WEBHOOKX_DATABASE_HOST: webhookx-database @@ -19,7 +19,7 @@ services: condition: service_healthy webhookx: - image: "webhookx-io/webhookx:latest" + image: "webhookx/webhookx:latest" container_name: webhookx environment: WEBHOOKX_DATABASE_HOST: webhookx-database @@ -49,10 +49,18 @@ services: interval: 3s timeout: 5s retries: 3 + volumes: + - "postgres_data:/var/lib/postgresql/data/" redis: image: redis:6 + command: "--appendonly yes --appendfsync everysec" + volumes: + - "redis_data:/data" +volumes: + postgres_data: + redis_data: ``` @@ -62,4 +70,4 @@ $ docker compose up ``` $ curl http://localhost:8080 -``` \ No newline at end of file +``` diff --git a/index.md b/index.md index ccaf5fd..918e745 100644 --- a/index.md +++ b/index.md @@ -4,12 +4,12 @@ layout: home hero: name: "WebhookX" - text: "An modern webhooks gateway" + text: "A modern webhooks gateway" tagline: WebhookX is an open-source webhooks gateway for message receiving, processing, and delivering. actions: - theme: alt text: Quickstart - link: /introduction/overview + link: /docs/index #features: diff --git a/introduction/overview.md b/introduction/overview.md deleted file mode 100644 index 6779d8c..0000000 --- a/introduction/overview.md +++ /dev/null @@ -1,4 +0,0 @@ -# WebhookX - - -WebhookX is an open-source webhooks gateway for message receiving, processing, and delivering.