From cc6a51da665288d80583423d50975910422b12d9 Mon Sep 17 00:00:00 2001 From: Maxim Babichev Date: Sat, 22 Jun 2024 19:38:56 +0300 Subject: [PATCH] update docs --- docs/.vitepress/config.mts | 64 +++++++++++++++++++++++++++++--------- docs/index.md | 6 ++++ 2 files changed, 56 insertions(+), 14 deletions(-) diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index 00ba61092..24b82c5db 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -21,9 +21,10 @@ export default defineConfig({ ], [ 'link', { - rel: 'mask-icon', + rel: 'icon', href: 'https://github.com/bavix/laravel-wallet/assets/5111255/f48a8e79-8a9d-469a-b056-b3d04835992d', - color: "#f4e664", + sizes: "any", + type: "image/svg+xml", } ], ], @@ -38,7 +39,6 @@ export default defineConfig({ nav: [ { text: 'Home', link: '/' }, { text: 'Guide', link: '/guide/introduction/' }, - { text: 'Chat', link: 'https://t.me/laravel_wallet' }, { text: 'Issues', link: 'https://github.com/bavix/laravel-wallet/issues' }, { text: 'Discussions', link: 'https://github.com/bavix/laravel-wallet/discussions' }, { text: 'Donate', link: 'https://opencollective.com/laravel-wallet' }, @@ -53,7 +53,8 @@ export default defineConfig({ { text: 'Configuration', link: '/guide/introduction/configuration' }, { text: 'Basic Usage', link: '/guide/introduction/basic-usage' }, { text: 'Upgrade', link: '/guide/introduction/upgrade' }, - ] + ], + collapsed: false, }, { text: 'Single/Default Wallet', @@ -66,7 +67,8 @@ export default defineConfig({ { text: 'Cancel Transaction', link: '/guide/single/cancel' }, { text: 'Exchange', link: '/guide/single/exchange' }, { text: 'Credit Limits', link: '/guide/single/credit-limits' }, - ] + ], + collapsed: false, }, { text: 'Multi Wallet', @@ -74,7 +76,8 @@ export default defineConfig({ { text: 'New Wallet', link: '/guide/multi/new-wallet' }, { text: 'Transfer', link: '/guide/multi/transfer' }, { text: 'Transaction Filter', link: '/guide/multi/transaction-filter' }, - ] + ], + collapsed: false, }, { text: 'Fractional Wallet', @@ -82,7 +85,8 @@ export default defineConfig({ { text: 'Deposit', link: '/guide/fractional/deposit' }, { text: 'Withdraw', link: '/guide/fractional/withdraw' }, { text: 'Transfer', link: '/guide/fractional/transfer' }, - ] + ], + collapsed: false, }, { text: 'Purchases', @@ -94,7 +98,8 @@ export default defineConfig({ { text: 'Cart', link: '/guide/purchases/cart' }, { text: 'Commissions', link: '/guide/purchases/commissions' }, { text: 'Customize receiving', link: '/guide/purchases/receiving' }, - ] + ], + collapsed: false, }, { text: 'Database Transaction', @@ -102,7 +107,8 @@ export default defineConfig({ { text: 'Atomic Service', link: '/guide/db/atomic-service' }, { text: 'Race Condition', link: '/guide/db/race-condition' }, { text: 'Transaction', link: '/guide/db/transaction' }, - ] + ], + collapsed: false, }, { text: 'Events', @@ -111,37 +117,67 @@ export default defineConfig({ { text: 'Wallet Created', link: '/guide/events/wallet-created-event' }, { text: 'Transaction Created', link: '/guide/events/transaction-created-event' }, { text: 'Customize', link: '/guide/events/customize' }, - ] + ], + collapsed: false, }, { text: 'Helpers', items: [ { text: 'Formatter', link: '/guide/helpers/formatter' }, - ] + ], + collapsed: false, }, { text: 'High performance api handles', items: [ { text: 'Batch Transactions', link: '/guide/high-performance/batch-transactions' }, { text: 'Batch Transfers', link: '/guide/high-performance/batch-transfers' }, - ] + ], + collapsed: false, }, { text: 'CQRS', items: [ { text: 'Create Wallet', link: '/guide/cqrs/create-wallet' }, - ] + ], + collapsed: false, }, { text: 'Additions', items: [ { text: 'Wallet Swap', link: '/guide/additions/swap' }, { text: 'Support UUID', link: '/guide/additions/uuid' }, - ] + ], + collapsed: false, }, ], socialLinks: [ + { + link: 'https://t.me/laravel_wallet', + icon: { + svg: '' + }, + }, { icon: 'github', link: 'https://github.com/bavix/laravel-wallet' }, ], diff --git a/docs/index.md b/docs/index.md index d03c73d65..546ff3327 100644 --- a/docs/index.md +++ b/docs/index.md @@ -21,20 +21,26 @@ features: - title: Default Wallet details: For simple projects when there is no need for multiple wallets. icon: 💰 + link: /guide/single/deposit - title: Multi wallets details: Many wallets for one model. Easy API. icon: 🎒 + link: /guide/multi/new-wallet - title: Purchases details: E-commerce. Create goods and buy them using wallets. There are also shopping carts, availability, taxes and fees. icon: 🛍️ + link: /guide/purchases/payment - title: Exchanges details: Exchanges between wallets. Convert currency from one wallet to another. icon: 💱 + link: /guide/single/exchange - title: Support UUID details: Models with UUID are supported. icon: ❄️ + link: /guide/additions/uuid - title: Events details: For more complex projects there are events and high performance API. icon: 📻 + link: /guide/events/balance-updated-event ---