From f510f3cdd1c876ec598401c45d08b728bfb8a7c1 Mon Sep 17 00:00:00 2001 From: Roshan Kumar Chatei Date: Tue, 4 Nov 2025 15:48:08 +0530 Subject: [PATCH 1/3] updated docs structure --- api-reference/introduction.mdx | 33 -- api-reference/openapi.json | 195 ----------- .../endpoints}/endpoint/create.mdx | 0 .../endpoints}/endpoint/delete.mdx | 0 .../endpoints}/endpoint/get.mdx | 0 api/introduction.mdx | 69 ++++ api/overview.mdx | 39 +++ {webhooks => api/webhooks}/acr.mdx | 0 changelog.mdx => changelog/index.mdx | 0 .../features/abandoned-cart.mdx | 0 .../amount-off-products-order-discount.mdx | 0 .../features/coupons/bundle.mdx | 0 .../features/coupons/buy-x-get-y.mdx | 0 .../features/coupons/exclusive-free-gift.mdx | 0 .../features/coupons/free-shipping.mdx | 0 .../features/coupons/purchase-driven.mdx | 0 .../features/customizations}/address.mdx | 0 .../features/customizations}/general.mdx | 0 .../features/customizations}/login.mdx | 0 .../features/customizations}/payments.mdx | 0 .../features/dashboard.mdx | 0 .../features/payment-offers.mdx | 0 .../features/rto-suite.mdx | 0 .../features/settings/activity-logs.mdx | 0 .../features/settings/api-keys.mdx | 0 .../features/settings/change-password.mdx | 0 .../features/settings}/integrations.mdx | 0 .../features/settings}/payments.mdx | 0 .../features/settings/store-details.mdx | 0 .../features/settings/taxes-and-duties.mdx | 0 .../settings/users-and-permissions.mdx | 0 .../features/shipping.mdx | 0 upsell.mdx => checkout/features/upsell.mdx | 0 .../getting-started/onboarding.mdx | 0 .../integrations}/analytics/google-ads.mdx | 0 .../analytics/google-analytics.mdx | 0 .../integrations}/analytics/meta.mdx | 0 .../integrations}/payment/cashfree.mdx | 0 .../integrations}/payment/cc-avenue.mdx | 0 .../integrations}/payment/easebuzz.mdx | 0 .../integrations}/payment/payu.mdx | 0 .../integrations}/payment/phonepe.mdx | 0 .../integrations}/payment/razorpay.mdx | 0 .../integrations}/payment/snapmint.mdx | 0 .../integrations}/payment/xpay.mdx | 0 checkout/introduction.mdx | 56 +++ intro.mdx => checkout/overview.mdx | 28 +- coupons/overview.mdx | 70 ---- customizations/overview.mdx | 54 --- development.mdx | 107 ------ docs.json | 125 ++++--- essentials/code.mdx | 37 -- essentials/images.mdx | 59 ---- essentials/markdown.mdx | 88 ----- essentials/navigation.mdx | 87 ----- essentials/reusable-snippets.mdx | 110 ------ essentials/settings.mdx | 318 ------------------ index.mdx | 106 ++++++ pass/getting-started/setup.mdx | 113 +++++++ pass/introduction.mdx | 50 +++ pass/overview.mdx | 35 ++ settings/overview.mdx | 78 ----- 62 files changed, 554 insertions(+), 1303 deletions(-) delete mode 100644 api-reference/introduction.mdx delete mode 100644 api-reference/openapi.json rename {api-reference => api/endpoints}/endpoint/create.mdx (100%) rename {api-reference => api/endpoints}/endpoint/delete.mdx (100%) rename {api-reference => api/endpoints}/endpoint/get.mdx (100%) create mode 100644 api/introduction.mdx create mode 100644 api/overview.mdx rename {webhooks => api/webhooks}/acr.mdx (100%) rename changelog.mdx => changelog/index.mdx (100%) rename abandonedcart.mdx => checkout/features/abandoned-cart.mdx (100%) rename coupons/AmountOffProducts_OrderDiscount.mdx => checkout/features/coupons/amount-off-products-order-discount.mdx (100%) rename coupons/Bundle.mdx => checkout/features/coupons/bundle.mdx (100%) rename coupons/buyxgety.mdx => checkout/features/coupons/buy-x-get-y.mdx (100%) rename coupons/ExclusiveFreeGift.mdx => checkout/features/coupons/exclusive-free-gift.mdx (100%) rename coupons/FreeShipping.mdx => checkout/features/coupons/free-shipping.mdx (100%) rename coupons/PurchaseDriven.mdx => checkout/features/coupons/purchase-driven.mdx (100%) rename {customizations => checkout/features/customizations}/address.mdx (100%) rename {customizations => checkout/features/customizations}/general.mdx (100%) rename {customizations => checkout/features/customizations}/login.mdx (100%) rename {customizations => checkout/features/customizations}/payments.mdx (100%) rename dashboard.mdx => checkout/features/dashboard.mdx (100%) rename paymentoffers.mdx => checkout/features/payment-offers.mdx (100%) rename rtosuite.mdx => checkout/features/rto-suite.mdx (100%) rename settings/activitylogs.mdx => checkout/features/settings/activity-logs.mdx (100%) rename settings/apikeys.mdx => checkout/features/settings/api-keys.mdx (100%) rename settings/changepassword.mdx => checkout/features/settings/change-password.mdx (100%) rename {settings => checkout/features/settings}/integrations.mdx (100%) rename {settings => checkout/features/settings}/payments.mdx (100%) rename settings/storedetails.mdx => checkout/features/settings/store-details.mdx (100%) rename settings/taxesandduties.mdx => checkout/features/settings/taxes-and-duties.mdx (100%) rename settings/usersandpermissions.mdx => checkout/features/settings/users-and-permissions.mdx (100%) rename shipping.mdx => checkout/features/shipping.mdx (100%) rename upsell.mdx => checkout/features/upsell.mdx (100%) rename onboarding.mdx => checkout/getting-started/onboarding.mdx (100%) rename {integrations => checkout/integrations}/analytics/google-ads.mdx (100%) rename {integrations => checkout/integrations}/analytics/google-analytics.mdx (100%) rename {integrations => checkout/integrations}/analytics/meta.mdx (100%) rename {integrations => checkout/integrations}/payment/cashfree.mdx (100%) rename {integrations => checkout/integrations}/payment/cc-avenue.mdx (100%) rename {integrations => checkout/integrations}/payment/easebuzz.mdx (100%) rename {integrations => checkout/integrations}/payment/payu.mdx (100%) rename {integrations => checkout/integrations}/payment/phonepe.mdx (100%) rename {integrations => checkout/integrations}/payment/razorpay.mdx (100%) rename {integrations => checkout/integrations}/payment/snapmint.mdx (100%) rename {integrations => checkout/integrations}/payment/xpay.mdx (100%) create mode 100644 checkout/introduction.mdx rename intro.mdx => checkout/overview.mdx (97%) delete mode 100644 coupons/overview.mdx delete mode 100644 customizations/overview.mdx delete mode 100644 development.mdx delete mode 100644 essentials/code.mdx delete mode 100644 essentials/images.mdx delete mode 100644 essentials/markdown.mdx delete mode 100644 essentials/navigation.mdx delete mode 100644 essentials/reusable-snippets.mdx delete mode 100644 essentials/settings.mdx create mode 100644 index.mdx create mode 100644 pass/getting-started/setup.mdx create mode 100644 pass/introduction.mdx create mode 100644 pass/overview.mdx delete mode 100644 settings/overview.mdx diff --git a/api-reference/introduction.mdx b/api-reference/introduction.mdx deleted file mode 100644 index c835b78..0000000 --- a/api-reference/introduction.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: 'Introduction' -description: 'Example section for showcasing API endpoints' ---- - - - If you're not looking to build API reference documentation, you can delete - this section by removing the api-reference folder. - - -## Welcome - -There are two ways to build API documentation: [OpenAPI](https://mintlify.com/docs/api-playground/openapi/setup) and [MDX components](https://mintlify.com/docs/api-playground/mdx/configuration). For the starter kit, we are using the following OpenAPI specification. - - - View the OpenAPI specification file - - -## Authentication - -All API endpoints are authenticated using Bearer tokens and picked up from the specification file. - -```json -"security": [ - { - "bearerAuth": [] - } -] -``` diff --git a/api-reference/openapi.json b/api-reference/openapi.json deleted file mode 100644 index b1509be..0000000 --- a/api-reference/openapi.json +++ /dev/null @@ -1,195 +0,0 @@ -{ - "openapi": "3.0.1", - "info": { - "title": "OpenAPI Plant Store", - "description": "A sample API that uses a plant store as an example to demonstrate features in the OpenAPI specification", - "license": { - "name": "MIT" - }, - "version": "1.0.0" - }, - "servers": [ - { - "url": "http://sandbox.mintlify.com" - } - ], - "security": [ - { - "bearerAuth": [] - } - ], - "paths": { - "/plants": { - "get": { - "description": "Returns all plants from the system that the user has access to", - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "The maximum number of results to return", - "schema": { - "type": "integer", - "format": "int32" - } - } - ], - "responses": { - "200": { - "description": "Plant response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Plant" - } - } - } - } - }, - "400": { - "description": "Unexpected error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - } - } - }, - "post": { - "description": "Creates a new plant in the store", - "requestBody": { - "description": "Plant to add to the store", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/NewPlant" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "plant response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Plant" - } - } - } - }, - "400": { - "description": "unexpected error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - } - } - } - }, - "/plants/{id}": { - "delete": { - "description": "Deletes a single plant based on the ID supplied", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "ID of plant to delete", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - } - ], - "responses": { - "204": { - "description": "Plant deleted", - "content": {} - }, - "400": { - "description": "unexpected error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - } - } - } - } - }, - "components": { - "schemas": { - "Plant": { - "required": [ - "name" - ], - "type": "object", - "properties": { - "name": { - "description": "The name of the plant", - "type": "string" - }, - "tag": { - "description": "Tag to specify the type", - "type": "string" - } - } - }, - "NewPlant": { - "allOf": [ - { - "$ref": "#/components/schemas/Plant" - }, - { - "required": [ - "id" - ], - "type": "object", - "properties": { - "id": { - "description": "Identification number of the plant", - "type": "integer", - "format": "int64" - } - } - } - ] - }, - "Error": { - "required": [ - "error", - "message" - ], - "type": "object", - "properties": { - "error": { - "type": "integer", - "format": "int32" - }, - "message": { - "type": "string" - } - } - } - }, - "securitySchemes": { - "bearerAuth": { - "type": "http", - "scheme": "bearer" - } - } - } -} \ No newline at end of file diff --git a/api-reference/endpoint/create.mdx b/api/endpoints/endpoint/create.mdx similarity index 100% rename from api-reference/endpoint/create.mdx rename to api/endpoints/endpoint/create.mdx diff --git a/api-reference/endpoint/delete.mdx b/api/endpoints/endpoint/delete.mdx similarity index 100% rename from api-reference/endpoint/delete.mdx rename to api/endpoints/endpoint/delete.mdx diff --git a/api-reference/endpoint/get.mdx b/api/endpoints/endpoint/get.mdx similarity index 100% rename from api-reference/endpoint/get.mdx rename to api/endpoints/endpoint/get.mdx diff --git a/api/introduction.mdx b/api/introduction.mdx new file mode 100644 index 0000000..8ad9db7 --- /dev/null +++ b/api/introduction.mdx @@ -0,0 +1,69 @@ +--- +title: "Introduction" +description: "Welcome to FlexyPe API - Build powerful integrations" +--- + +# FlexyPe API + +Welcome to the FlexyPe API! Build powerful integrations and automate your checkout workflow. + +## What is the FlexyPe API? + +The FlexyPe API is a comprehensive RESTful API that allows developers to programmatically interact with FlexyPe's checkout, pass, and order management systems. It provides endpoints for managing checkout configurations, processing orders, tracking customers, and accessing real-time analytics. + +## Our Mission + +We're committed to providing developers with: + +- **Flexible Integration**: Seamlessly integrate FlexyPe into your systems +- **Powerful Automation**: Automate checkout and order workflows +- **Real-time Data**: Access up-to-date information through our API +- **Developer-Friendly**: Clear documentation and comprehensive examples +- **Reliable Performance**: Enterprise-grade stability and uptime + +## Why Use FlexyPe API? + +🔌 **Easy Integration** - RESTful API with clear endpoints + +🔐 **Secure** - API key authentication and enterprise security + +📊 **Comprehensive** - Access all FlexyPe data and functionality + +⚡ **Real-time** - Webhooks for instant notifications + +📚 **Well-Documented** - Complete API reference and guides + +🛠️ **Developer Tools** - SDKs and example code included + +## What You Can Do + +With the FlexyPe API, you can: + +- Manage checkout configurations programmatically +- Create and retrieve orders +- Manage customer data +- Track analytics and performance metrics +- Subscribe to real-time webhook events +- Build custom integrations + +## What You'll Learn + +In this documentation, you'll discover: + +- How to authenticate API requests +- Complete endpoint reference +- Real-time webhook setup +- Example integrations +- Best practices for API usage +- Error handling and troubleshooting + +## Base URL + +All API requests use the base URL: +``` +https://api.flexype.io/v1 +``` + +## Getting Started + +Ready to build? Let's dive into the API documentation! diff --git a/api/overview.mdx b/api/overview.mdx new file mode 100644 index 0000000..b10797e --- /dev/null +++ b/api/overview.mdx @@ -0,0 +1,39 @@ +--- +title: "Overview" +description: "FlexyPe API documentation" +--- + +# FlexyPe API + +The FlexyPe API allows you to programmatically manage your store, checkout configurations, orders, and more. + +## API Overview + +Our RESTful API provides endpoints for: + +- **Checkout Management**: Create and manage checkout flows +- **Order Management**: Access and process orders +- **Customer Data**: Manage customer information +- **Analytics**: Retrieve performance data +- **Webhooks**: Real-time event notifications + +## Authentication + +All API requests require authentication using your API key. Learn more in our [authentication guide](./getting-started/authentication). + +## Getting Started + +- **[API Introduction](./getting-started/intro)**: Overview and key concepts +- **[Authentication](./getting-started/authentication)**: Secure your API requests +- **[Endpoints](./endpoints)**: Complete endpoint reference +- **[Webhooks](./webhooks)**: Real-time event notifications + +## Base URL + +``` +https://api.flexype.io/v1 +``` + +## Support + +For API support and questions, email us at [hello@flexype.io](mailto:hello@flexype.io). diff --git a/webhooks/acr.mdx b/api/webhooks/acr.mdx similarity index 100% rename from webhooks/acr.mdx rename to api/webhooks/acr.mdx diff --git a/changelog.mdx b/changelog/index.mdx similarity index 100% rename from changelog.mdx rename to changelog/index.mdx diff --git a/abandonedcart.mdx b/checkout/features/abandoned-cart.mdx similarity index 100% rename from abandonedcart.mdx rename to checkout/features/abandoned-cart.mdx diff --git a/coupons/AmountOffProducts_OrderDiscount.mdx b/checkout/features/coupons/amount-off-products-order-discount.mdx similarity index 100% rename from coupons/AmountOffProducts_OrderDiscount.mdx rename to checkout/features/coupons/amount-off-products-order-discount.mdx diff --git a/coupons/Bundle.mdx b/checkout/features/coupons/bundle.mdx similarity index 100% rename from coupons/Bundle.mdx rename to checkout/features/coupons/bundle.mdx diff --git a/coupons/buyxgety.mdx b/checkout/features/coupons/buy-x-get-y.mdx similarity index 100% rename from coupons/buyxgety.mdx rename to checkout/features/coupons/buy-x-get-y.mdx diff --git a/coupons/ExclusiveFreeGift.mdx b/checkout/features/coupons/exclusive-free-gift.mdx similarity index 100% rename from coupons/ExclusiveFreeGift.mdx rename to checkout/features/coupons/exclusive-free-gift.mdx diff --git a/coupons/FreeShipping.mdx b/checkout/features/coupons/free-shipping.mdx similarity index 100% rename from coupons/FreeShipping.mdx rename to checkout/features/coupons/free-shipping.mdx diff --git a/coupons/PurchaseDriven.mdx b/checkout/features/coupons/purchase-driven.mdx similarity index 100% rename from coupons/PurchaseDriven.mdx rename to checkout/features/coupons/purchase-driven.mdx diff --git a/customizations/address.mdx b/checkout/features/customizations/address.mdx similarity index 100% rename from customizations/address.mdx rename to checkout/features/customizations/address.mdx diff --git a/customizations/general.mdx b/checkout/features/customizations/general.mdx similarity index 100% rename from customizations/general.mdx rename to checkout/features/customizations/general.mdx diff --git a/customizations/login.mdx b/checkout/features/customizations/login.mdx similarity index 100% rename from customizations/login.mdx rename to checkout/features/customizations/login.mdx diff --git a/customizations/payments.mdx b/checkout/features/customizations/payments.mdx similarity index 100% rename from customizations/payments.mdx rename to checkout/features/customizations/payments.mdx diff --git a/dashboard.mdx b/checkout/features/dashboard.mdx similarity index 100% rename from dashboard.mdx rename to checkout/features/dashboard.mdx diff --git a/paymentoffers.mdx b/checkout/features/payment-offers.mdx similarity index 100% rename from paymentoffers.mdx rename to checkout/features/payment-offers.mdx diff --git a/rtosuite.mdx b/checkout/features/rto-suite.mdx similarity index 100% rename from rtosuite.mdx rename to checkout/features/rto-suite.mdx diff --git a/settings/activitylogs.mdx b/checkout/features/settings/activity-logs.mdx similarity index 100% rename from settings/activitylogs.mdx rename to checkout/features/settings/activity-logs.mdx diff --git a/settings/apikeys.mdx b/checkout/features/settings/api-keys.mdx similarity index 100% rename from settings/apikeys.mdx rename to checkout/features/settings/api-keys.mdx diff --git a/settings/changepassword.mdx b/checkout/features/settings/change-password.mdx similarity index 100% rename from settings/changepassword.mdx rename to checkout/features/settings/change-password.mdx diff --git a/settings/integrations.mdx b/checkout/features/settings/integrations.mdx similarity index 100% rename from settings/integrations.mdx rename to checkout/features/settings/integrations.mdx diff --git a/settings/payments.mdx b/checkout/features/settings/payments.mdx similarity index 100% rename from settings/payments.mdx rename to checkout/features/settings/payments.mdx diff --git a/settings/storedetails.mdx b/checkout/features/settings/store-details.mdx similarity index 100% rename from settings/storedetails.mdx rename to checkout/features/settings/store-details.mdx diff --git a/settings/taxesandduties.mdx b/checkout/features/settings/taxes-and-duties.mdx similarity index 100% rename from settings/taxesandduties.mdx rename to checkout/features/settings/taxes-and-duties.mdx diff --git a/settings/usersandpermissions.mdx b/checkout/features/settings/users-and-permissions.mdx similarity index 100% rename from settings/usersandpermissions.mdx rename to checkout/features/settings/users-and-permissions.mdx diff --git a/shipping.mdx b/checkout/features/shipping.mdx similarity index 100% rename from shipping.mdx rename to checkout/features/shipping.mdx diff --git a/upsell.mdx b/checkout/features/upsell.mdx similarity index 100% rename from upsell.mdx rename to checkout/features/upsell.mdx diff --git a/onboarding.mdx b/checkout/getting-started/onboarding.mdx similarity index 100% rename from onboarding.mdx rename to checkout/getting-started/onboarding.mdx diff --git a/integrations/analytics/google-ads.mdx b/checkout/integrations/analytics/google-ads.mdx similarity index 100% rename from integrations/analytics/google-ads.mdx rename to checkout/integrations/analytics/google-ads.mdx diff --git a/integrations/analytics/google-analytics.mdx b/checkout/integrations/analytics/google-analytics.mdx similarity index 100% rename from integrations/analytics/google-analytics.mdx rename to checkout/integrations/analytics/google-analytics.mdx diff --git a/integrations/analytics/meta.mdx b/checkout/integrations/analytics/meta.mdx similarity index 100% rename from integrations/analytics/meta.mdx rename to checkout/integrations/analytics/meta.mdx diff --git a/integrations/payment/cashfree.mdx b/checkout/integrations/payment/cashfree.mdx similarity index 100% rename from integrations/payment/cashfree.mdx rename to checkout/integrations/payment/cashfree.mdx diff --git a/integrations/payment/cc-avenue.mdx b/checkout/integrations/payment/cc-avenue.mdx similarity index 100% rename from integrations/payment/cc-avenue.mdx rename to checkout/integrations/payment/cc-avenue.mdx diff --git a/integrations/payment/easebuzz.mdx b/checkout/integrations/payment/easebuzz.mdx similarity index 100% rename from integrations/payment/easebuzz.mdx rename to checkout/integrations/payment/easebuzz.mdx diff --git a/integrations/payment/payu.mdx b/checkout/integrations/payment/payu.mdx similarity index 100% rename from integrations/payment/payu.mdx rename to checkout/integrations/payment/payu.mdx diff --git a/integrations/payment/phonepe.mdx b/checkout/integrations/payment/phonepe.mdx similarity index 100% rename from integrations/payment/phonepe.mdx rename to checkout/integrations/payment/phonepe.mdx diff --git a/integrations/payment/razorpay.mdx b/checkout/integrations/payment/razorpay.mdx similarity index 100% rename from integrations/payment/razorpay.mdx rename to checkout/integrations/payment/razorpay.mdx diff --git a/integrations/payment/snapmint.mdx b/checkout/integrations/payment/snapmint.mdx similarity index 100% rename from integrations/payment/snapmint.mdx rename to checkout/integrations/payment/snapmint.mdx diff --git a/integrations/payment/xpay.mdx b/checkout/integrations/payment/xpay.mdx similarity index 100% rename from integrations/payment/xpay.mdx rename to checkout/integrations/payment/xpay.mdx diff --git a/checkout/introduction.mdx b/checkout/introduction.mdx new file mode 100644 index 0000000..970d01c --- /dev/null +++ b/checkout/introduction.mdx @@ -0,0 +1,56 @@ +--- +title: "Introduction" +description: "Welcome to FlexyPe Checkout - Your one-click solution to boost conversions" +--- + +FlexyPe Checkout + +# FlexyPe Checkout + +Welcome to FlexyPe Checkout! We're here to help you transform your checkout experience and maximize conversions. + +## What is FlexyPe Checkout? + +FlexyPe Checkout is a fast, flexible, and secure one-click checkout solution built specifically for Shopify. It's designed to simplify the checkout process, reduce cart abandonment, and increase conversion rates by providing customers with a seamless payment experience. + +## Our Mission + +At FlexyPe, we believe that checking out should be the smoothest part of the customer journey—not a hurdle. Our mission is to revolutionize the way businesses handle payments by: + +- **Reducing Friction**: Simplify the checkout process with one-click purchasing +- **Boosting Conversions**: Minimize cart abandonment and increase average order value +- **Supporting Multiple Methods**: Accept various payment methods and provide flexibility +- **Ensuring Security**: Maintain secure, hassle-free transactions +- **Scaling Your Business**: Provide tools that grow with your business + +## Why Choose FlexyPe Checkout? + +✨ **Simple & Fast** - One-click checkout experience for your customers + +🔒 **Secure** - Enterprise-grade security for all transactions + +🎨 **Customizable** - Tailor the checkout to match your brand + +💳 **Multiple Payments** - Support all major payment providers + +📊 **Analytics** - Real-time insights into your checkout performance + +🛠️ **Easy to Setup** - Get started in minutes with Shopify integration + +## What You'll Learn + +In this documentation, you'll discover: + +- How to set up and configure your checkout +- Ways to optimize your checkout for maximum conversions +- How to integrate payment providers +- Best practices for reducing cart abandonment +- Advanced features like upsells, discounts, and customization + +## Simple. Scalable. Secure. + +That's the FlexyPe way. Let's get started! diff --git a/intro.mdx b/checkout/overview.mdx similarity index 97% rename from intro.mdx rename to checkout/overview.mdx index 89d1a4c..2e99306 100644 --- a/intro.mdx +++ b/checkout/overview.mdx @@ -1,5 +1,5 @@ --- -title: "Dashboard Handbook" +title: "Overview" mode: "wide" description: "Your complete guide to mastering the FlexyPe Checkout Dashboard" --- @@ -12,35 +12,35 @@ Get started with FlexyPe's powerful checkout platform. Everything you need to op Monitor your store's performance with real-time analytics and insights - + Recover lost sales with automated cart recovery campaigns - + Configure shipping zones, rates, and delivery options - + Create payment-specific discounts to boost conversions - + Increase AOV with pre and post-purchase upsell offers - + Reduce return-to-origin rates with AI-powered verification - + Create versatile discount campaigns and promotional offers - + Customize your checkout to match your brand identity - + Configure store, payments, integrations, and team access @@ -52,15 +52,15 @@ Get started with FlexyPe's powerful checkout platform. Everything you need to op Navigate to the Coupons section and choose from various discount types like Amount Off, Buy X Get Y, or Free Shipping. Configure your rules and activate the campaign. - + Enable the RTO Suite to add OTP verification, address validation, and fraud detection. This helps confirm genuine orders before fulfillment. - + Yes! Visit the Customization section to modify colors, fonts, layout, and add custom fields to match your brand identity. - + The Abandoned Cart dashboard shows all incomplete checkouts. Enable automated recovery emails and SMS to bring customers back. @@ -72,8 +72,8 @@ Get started with FlexyPe's powerful checkout platform. Everything you need to op Get in touch with our support team - + Explore our developer documentation - \ No newline at end of file + diff --git a/coupons/overview.mdx b/coupons/overview.mdx deleted file mode 100644 index 3424779..0000000 --- a/coupons/overview.mdx +++ /dev/null @@ -1,70 +0,0 @@ ---- -title: "Coupons & Discounts" -description: "Create powerful discount campaigns to boost conversions and increase customer loyalty" ---- - -FlexyPe's coupon system gives you complete control over promotional campaigns. From simple percentage discounts to complex purchase-driven offers, you can create targeted promotions that drive sales while protecting your margins. - -## Available Coupon Types - - - - Percentage or fixed discounts on orders or products for sales. - - - - "Buy 1 Get 1 Free" or tiered deals to boost cart size. - - - - Personalized rewards based on customer history. - - - - Auto-add free items to qualifying orders. - - - - Waive shipping fees to cut abandonment. - - - - Special pricing for grouped products. - - - -## Frequently Asked Questions - - - - In [Amount Off Products/Order](/coupons/AmountOffProducts_OrderDiscount), choose percentage or fixed value, apply to specific products/collections, and set min cart thresholds for targeted sales. - - - - Configure in [Buy X Get Y](/coupons/buyxgety) with quantity tiers (e.g., Buy 2 Get 1 50% Off), limit to collections, and enable auto-apply to encourage upsells. - - - - Use [Purchase Driven](/coupons/PurchaseDriven) to base discounts on order history, like 10% off for 3+ purchases, with per-customer limits to reward repeats. - - - - Set up in [Free Shipping](/coupons/FreeShipping) with min order values to boost AOV, or auto-apply for first-timers to reduce early abandonment. - - - - Across all types, add global/per-customer usage caps, date ranges, and COD restrictions in usage controls to safeguard margins. - - - -## Need Help? - - - - Questions about coupon setup? Our team is here to help. - - - - Start with Amount Off discounts - the most versatile option. - - \ No newline at end of file diff --git a/customizations/overview.mdx b/customizations/overview.mdx deleted file mode 100644 index 8b1705a..0000000 --- a/customizations/overview.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: "Checkout Customization" -description: "The **Checkout Customization** suite empowers brands to shape every element of their checkout flow—from logos and colors to upsells, payments, and trust badges. Deliver a visually consistent, conversion-optimized experience across all steps." ---- - -## Overview - -FlexyPe’s **Checkout Customization** suite gives complete control over every stage of the checkout journey — from branding and layout to upsells, coupons, and payments. -Create a consistent, high-converting checkout experience that matches your brand identity. - ---- - -## Customization Areas - - - - Define your brand look with logos, colors, and layouts across the checkout. - - - - Personalize the login step with banners, trust badges, and upsell prompts. - - - - Add banners, coupons, and upsells while ensuring accurate delivery details. - - - - Configure layouts, highlight payment offers, and manage billing or GST info. - - - ---- - -## Key Highlights - -- **Branding:** Upload logos, set colors, and define button and background styles. -- **Banners:** Display offers or messages at login, address, or payment steps. -- **Coupons:** Enable coupon display and locked coupons to boost engagement. -- **Upselling:** Recommend products at multiple stages to increase order value. -- **Trust Elements:** Add badges like *“Secure Payment”* or *“Cash on Pickup.”* -- **Layout Control:** Reorder checkout sections and choose coupon or payment layouts. -- **Payments:** Manage available methods and highlight UPI, wallet, or EMI offers. -- **Address Flexibility:** Add optional lines or make them mandatory for accuracy. - ---- - -## Strategic Value - -Checkout customization helps you: -- Build **brand trust** through consistent visuals and clear messaging. -- **Increase conversions** by reducing friction at every step. -- **Boost average order value** via contextual upsells and highlighted offers. -- **Improve retention** with transparent, user-friendly checkout experiences. diff --git a/development.mdx b/development.mdx deleted file mode 100644 index ad03bb8..0000000 --- a/development.mdx +++ /dev/null @@ -1,107 +0,0 @@ ---- -title: 'Development' -description: 'Preview changes locally to update your docs' ---- - - - **Prerequisite**: Please install Node.js (version 19 or higher) before proceeding.
- Please upgrade to ```docs.json``` before proceeding and delete the legacy ```mint.json``` file. - - -Follow these steps to install and run Mintlify on your operating system: - -**Step 1**: Install Mintlify: - - - - ```bash npm - npm i -g mintlify - ``` - -```bash yarn -yarn global add mintlify -``` - - - -**Step 2**: Navigate to the docs directory (where the `docs.json` file is located) and execute the following command: - -```bash -mintlify dev -``` - -A local preview of your documentation will be available at `http://localhost:3000`. - -### Custom Ports - -By default, Mintlify uses port 3000. You can customize the port Mintlify runs on by using the `--port` flag. To run Mintlify on port 3333, for instance, use this command: - -```bash -mintlify dev --port 3333 -``` - -If you attempt to run Mintlify on a port that's already in use, it will use the next available port: - -```md -Port 3000 is already in use. Trying 3001 instead. -``` - -## Mintlify Versions - -Please note that each CLI release is associated with a specific version of Mintlify. If your local website doesn't align with the production version, please update the CLI: - - - -```bash npm -npm i -g mintlify@latest -``` - -```bash yarn -yarn global upgrade mintlify -``` - - - -## Validating Links - -The CLI can assist with validating reference links made in your documentation. To identify any broken links, use the following command: - -```bash -mintlify broken-links -``` - -## Deployment - - - Unlimited editors available under the [Pro - Plan](https://mintlify.com/pricing) and above. - - -If the deployment is successful, you should see the following: - - - - - -## Code Formatting - -We suggest using extensions on your IDE to recognize and format MDX. If you're a VSCode user, consider the [MDX VSCode extension](https://marketplace.visualstudio.com/items?itemName=unifiedjs.vscode-mdx) for syntax highlighting, and [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) for code formatting. - -## Troubleshooting - - - - - This may be due to an outdated version of node. Try the following: - 1. Remove the currently-installed version of mintlify: `npm remove -g mintlify` - 2. Upgrade to Node v19 or higher. - 3. Reinstall mintlify: `npm install -g mintlify` - - - - - Solution: Go to the root of your device and delete the \~/.mintlify folder. Afterwards, run `mintlify dev` again. - - - -Curious about what changed in the CLI version? [Check out the CLI changelog.](https://www.npmjs.com/package/mintlify?activeTab=versions) diff --git a/docs.json b/docs.json index 96783d8..ceeb6a5 100644 --- a/docs.json +++ b/docs.json @@ -22,11 +22,50 @@ "navigation": { "tabs": [ { - "tab": "Documentation", + "tab": "Checkout", "groups": [ { "group": "Get Started", - "pages": ["introduction", "onboarding"] + "pages": ["checkout/introduction", "checkout/overview", "checkout/getting-started/onboarding"] + }, + { + "group": "Features", + "pages": [ + "checkout/features/dashboard", + "checkout/features/abandoned-cart", + "checkout/features/shipping", + { + "group": "Coupons", + "pages": [ + "checkout/features/coupons/amount-off-products-order-discount", + "checkout/features/coupons/buy-x-get-y", + "checkout/features/coupons/purchase-driven", + "checkout/features/coupons/exclusive-free-gift", + "checkout/features/coupons/free-shipping", + "checkout/features/coupons/bundle" + ] + }, + "checkout/features/payment-offers", + "checkout/features/upsell", + { + "group": "Customization", + "pages": ["checkout/features/customizations/general", "checkout/features/customizations/login", "checkout/features/customizations/address", "checkout/features/customizations/payments"] + }, + "checkout/features/rto-suite", + { + "group": "Settings", + "pages": [ + "checkout/features/settings/store-details", + "checkout/features/settings/payments", + "checkout/features/settings/taxes-and-duties", + "checkout/features/settings/integrations", + "checkout/features/settings/api-keys", + "checkout/features/settings/users-and-permissions", + "checkout/features/settings/activity-logs", + "checkout/features/settings/change-password" + ] + } + ] }, { "group": "Integrations", @@ -34,73 +73,53 @@ { "group": "Payment Providers", "pages": [ - "integrations/payment/razorpay", - "integrations/payment/easebuzz", - "integrations/payment/cashfree", - "integrations/payment/payu", - "integrations/payment/xpay", - "integrations/payment/phonepe", - "integrations/payment/snapmint", - "integrations/payment/cc-avenue" + "checkout/integrations/payment/razorpay", + "checkout/integrations/payment/easebuzz", + "checkout/integrations/payment/cashfree", + "checkout/integrations/payment/payu", + "checkout/integrations/payment/xpay", + "checkout/integrations/payment/phonepe", + "checkout/integrations/payment/snapmint", + "checkout/integrations/payment/cc-avenue" ] }, { "group": "Analytics", - "pages": ["integrations/analytics/meta", "integrations/analytics/google-ads", "integrations/analytics/google-analytics"] + "pages": ["checkout/integrations/analytics/meta", "checkout/integrations/analytics/google-ads", "checkout/integrations/analytics/google-analytics"] } ] - }, + } + ] + }, + + { + "tab": "Pass", + "groups": [ { - "group": "Webhooks", - "pages": ["webhooks/acr"] + "group": "Get Started", + "pages": ["pass/introduction", "pass/overview"] } ] }, { - "tab": "Dashboard Handbook", + "tab": "API", "groups": [ { "group": "Get Started", + "pages": ["api/introduction", "api/overview"] + }, + { + "group": "Endpoints", "pages": [ - "intro", - "dashboard", - "abandonedcart", - "shipping", - { - "group": "Coupons", - "pages": [ - "coupons/overview", - "coupons/AmountOffProducts_OrderDiscount", - "coupons/buyxgety", - "coupons/PurchaseDriven", - "coupons/ExclusiveFreeGift", - "coupons/FreeShipping", - "coupons/Bundle" - ] - }, - "paymentoffers", - "upsell", - { - "group": "Customization", - "pages": ["customizations/overview", "customizations/general", "customizations/login", "customizations/address", "customizations/payments"] - }, - "rtosuite", - { - "group": "Settings", - "pages": [ - "settings/overview", - "settings/storedetails", - "settings/payments", - "settings/taxesandduties", - "settings/integrations", - "settings/apikeys", - "settings/usersandpermissions", - "settings/activitylogs", - "settings/changepassword" - ] - } + "api/endpoints/endpoint/create", + "api/endpoints/endpoint/get", + "api/endpoints/endpoint/delete" ] + }, + { + "group": "Webhooks", + "pages": ["api/webhooks/acr"] } ] }, @@ -110,7 +129,7 @@ "groups": [ { "group": "Release Notes", - "pages": ["changelog"] + "pages": ["changelog/index"] } ] } diff --git a/essentials/code.mdx b/essentials/code.mdx deleted file mode 100644 index d2a462a..0000000 --- a/essentials/code.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: 'Code Blocks' -description: 'Display inline code and code blocks' -icon: 'code' ---- - -## Basic - -### Inline Code - -To denote a `word` or `phrase` as code, enclose it in backticks (`). - -``` -To denote a `word` or `phrase` as code, enclose it in backticks (`). -``` - -### Code Block - -Use [fenced code blocks](https://www.markdownguide.org/extended-syntax/#fenced-code-blocks) by enclosing code in three backticks and follow the leading ticks with the programming language of your snippet to get syntax highlighting. Optionally, you can also write the name of your code after the programming language. - -```java HelloWorld.java -class HelloWorld { - public static void main(String[] args) { - System.out.println("Hello, World!"); - } -} -``` - -````md -```java HelloWorld.java -class HelloWorld { - public static void main(String[] args) { - System.out.println("Hello, World!"); - } -} -``` -```` diff --git a/essentials/images.mdx b/essentials/images.mdx deleted file mode 100644 index 60ad42d..0000000 --- a/essentials/images.mdx +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: 'Images and Embeds' -description: 'Add image, video, and other HTML elements' -icon: 'image' ---- - - - -## Image - -### Using Markdown - -The [markdown syntax](https://www.markdownguide.org/basic-syntax/#images) lets you add images using the following code - -```md -![title](/path/image.jpg) -``` - -Note that the image file size must be less than 5MB. Otherwise, we recommend hosting on a service like [Cloudinary](https://cloudinary.com/) or [S3](https://aws.amazon.com/s3/). You can then use that URL and embed. - -### Using Embeds - -To get more customizability with images, you can also use [embeds](/writing-content/embed) to add images - -```html - -``` - -## Embeds and HTML elements - - - -
- - - -Mintlify supports [HTML tags in Markdown](https://www.markdownguide.org/basic-syntax/#html). This is helpful if you prefer HTML tags to Markdown syntax, and lets you create documentation with infinite flexibility. - - - -### iFrames - -Loads another HTML page within the document. Most commonly used for embedding videos. - -```html - -``` diff --git a/essentials/markdown.mdx b/essentials/markdown.mdx deleted file mode 100644 index c8ad9c1..0000000 --- a/essentials/markdown.mdx +++ /dev/null @@ -1,88 +0,0 @@ ---- -title: 'Markdown Syntax' -description: 'Text, title, and styling in standard markdown' -icon: 'text-size' ---- - -## Titles - -Best used for section headers. - -```md -## Titles -``` - -### Subtitles - -Best use to subsection headers. - -```md -### Subtitles -``` - - - -Each **title** and **subtitle** creates an anchor and also shows up on the table of contents on the right. - - - -## Text Formatting - -We support most markdown formatting. Simply add `**`, `_`, or `~` around text to format it. - -| Style | How to write it | Result | -| ------------- | ----------------- | --------------- | -| Bold | `**bold**` | **bold** | -| Italic | `_italic_` | _italic_ | -| Strikethrough | `~strikethrough~` | ~strikethrough~ | - -You can combine these. For example, write `**_bold and italic_**` to get **_bold and italic_** text. - -You need to use HTML to write superscript and subscript text. That is, add `` or `` around your text. - -| Text Size | How to write it | Result | -| ----------- | ------------------------ | ---------------------- | -| Superscript | `superscript` | superscript | -| Subscript | `subscript` | subscript | - -## Linking to Pages - -You can add a link by wrapping text in `[]()`. You would write `[link to google](https://google.com)` to [link to google](https://google.com). - -Links to pages in your docs need to be root-relative. Basically, you should include the entire folder path. For example, `[link to text](/writing-content/text)` links to the page "Text" in our components section. - -Relative links like `[link to text](../text)` will open slower because we cannot optimize them as easily. - -## Blockquotes - -### Singleline - -To create a blockquote, add a `>` in front of a paragraph. - -> Dorothy followed her through many of the beautiful rooms in her castle. - -```md -> Dorothy followed her through many of the beautiful rooms in her castle. -``` - -### Multiline - -> Dorothy followed her through many of the beautiful rooms in her castle. -> -> The Witch bade her clean the pots and kettles and sweep the floor and keep the fire fed with wood. - -```md -> Dorothy followed her through many of the beautiful rooms in her castle. -> -> The Witch bade her clean the pots and kettles and sweep the floor and keep the fire fed with wood. -``` - -### LaTeX - -Mintlify supports [LaTeX](https://www.latex-project.org) through the Latex component. - -8 x (vk x H1 - H2) = (0,1) - -```md -8 x (vk x H1 - H2) = (0,1) -``` diff --git a/essentials/navigation.mdx b/essentials/navigation.mdx deleted file mode 100644 index f21213c..0000000 --- a/essentials/navigation.mdx +++ /dev/null @@ -1,87 +0,0 @@ ---- -title: 'Navigation' -description: 'The navigation field in docs.json defines the pages that go in the navigation menu' -icon: 'map' ---- - -The navigation menu is the list of links on every website. - -You will likely update `docs.json` every time you add a new page. Pages do not show up automatically. - -## Navigation syntax - -Our navigation syntax is recursive which means you can make nested navigation groups. You don't need to include `.mdx` in page names. - - - -```json Regular Navigation -"navigation": { - "tabs": [ - { - "tab": "Docs", - "groups": [ - { - "group": "Getting Started", - "pages": ["quickstart"] - } - ] - } - ] -} -``` - -```json Nested Navigation -"navigation": { - "tabs": [ - { - "tab": "Docs", - "groups": [ - { - "group": "Getting Started", - "pages": [ - "quickstart", - { - "group": "Nested Reference Pages", - "pages": ["nested-reference-page"] - } - ] - } - ] - } - ] -} -``` - - - -## Folders - -Simply put your MDX files in folders and update the paths in `docs.json`. - -For example, to have a page at `https://yoursite.com/your-folder/your-page` you would make a folder called `your-folder` containing an MDX file called `your-page.mdx`. - - - -You cannot use `api` for the name of a folder unless you nest it inside another folder. Mintlify uses Next.js which reserves the top-level `api` folder for internal server calls. A folder name such as `api-reference` would be accepted. - - - -```json Navigation With Folder -"navigation": { - "tabs": [ - { - "tab": "Docs", - "groups": [ - { - "group": "Group Name", - "pages": ["your-folder/your-page"] - } - ] - } - ] -} -``` - -## Hidden Pages - -MDX files not included in `docs.json` will not show up in the sidebar but are accessible through the search bar and by linking directly to them. diff --git a/essentials/reusable-snippets.mdx b/essentials/reusable-snippets.mdx deleted file mode 100644 index a0a5529..0000000 --- a/essentials/reusable-snippets.mdx +++ /dev/null @@ -1,110 +0,0 @@ ---- -title: Reusable Snippets -description: Reusable, custom snippets to keep content in sync -icon: 'recycle' ---- - -import SnippetIntro from '/snippets/snippet-intro.mdx'; - - - -## Creating a custom snippet - -**Pre-condition**: You must create your snippet file in the `snippets` directory. - - - Any page in the `snippets` directory will be treated as a snippet and will not - be rendered into a standalone page. If you want to create a standalone page - from the snippet, import the snippet into another file and call it as a - component. - - -### Default export - -1. Add content to your snippet file that you want to re-use across multiple - locations. Optionally, you can add variables that can be filled in via props - when you import the snippet. - -```mdx snippets/my-snippet.mdx -Hello world! This is my content I want to reuse across pages. My keyword of the -day is {word}. -``` - - - The content that you want to reuse must be inside the `snippets` directory in - order for the import to work. - - -2. Import the snippet into your destination file. - -```mdx destination-file.mdx ---- -title: My title -description: My Description ---- - -import MySnippet from '/snippets/path/to/my-snippet.mdx'; - -## Header - -Lorem impsum dolor sit amet. - - -``` - -### Reusable variables - -1. Export a variable from your snippet file: - -```mdx snippets/path/to/custom-variables.mdx -export const myName = 'my name'; - -export const myObject = { fruit: 'strawberries' }; -``` - -2. Import the snippet from your destination file and use the variable: - -```mdx destination-file.mdx ---- -title: My title -description: My Description ---- - -import { myName, myObject } from '/snippets/path/to/custom-variables.mdx'; - -Hello, my name is {myName} and I like {myObject.fruit}. -``` - -### Reusable components - -1. Inside your snippet file, create a component that takes in props by exporting - your component in the form of an arrow function. - -```mdx snippets/custom-component.mdx -export const MyComponent = ({ title }) => ( -
-

{title}

-

... snippet content ...

-
-); -``` - - - MDX does not compile inside the body of an arrow function. Stick to HTML - syntax when you can or use a default export if you need to use MDX. - - -2. Import the snippet into your destination file and pass in the props - -```mdx destination-file.mdx ---- -title: My title -description: My Description ---- - -import { MyComponent } from '/snippets/custom-component.mdx'; - -Lorem ipsum dolor sit amet. - - -``` diff --git a/essentials/settings.mdx b/essentials/settings.mdx deleted file mode 100644 index 884de13..0000000 --- a/essentials/settings.mdx +++ /dev/null @@ -1,318 +0,0 @@ ---- -title: 'Global Settings' -description: 'Mintlify gives you complete control over the look and feel of your documentation using the docs.json file' -icon: 'gear' ---- - -Every Mintlify site needs a `docs.json` file with the core configuration settings. Learn more about the [properties](#properties) below. - -## Properties - - -Name of your project. Used for the global title. - -Example: `mintlify` - - - - - An array of groups with all the pages within that group - - - The name of the group. - - Example: `Settings` - - - - The relative paths to the markdown files that will serve as pages. - - Example: `["customization", "page"]` - - - - - - - - Path to logo image or object with path to "light" and "dark" mode logo images - - - Path to the logo in light mode - - - Path to the logo in dark mode - - - Where clicking on the logo links you to - - - - - - Path to the favicon image - - - - Hex color codes for your global theme - - - The primary color. Used for most often for highlighted content, section - headers, accents, in light mode - - - The primary color for dark mode. Used for most often for highlighted - content, section headers, accents, in dark mode - - - The primary color for important buttons - - - The color of the background in both light and dark mode - - - The hex color code of the background in light mode - - - The hex color code of the background in dark mode - - - - - - - - Array of `name`s and `url`s of links you want to include in the topbar - - - The name of the button. - - Example: `Contact us` - - - The url once you click on the button. Example: `https://mintlify.com/docs` - - - - - - - - - Link shows a button. GitHub shows the repo information at the url provided including the number of GitHub stars. - - - If `link`: What the button links to. - - If `github`: Link to the repository to load GitHub information from. - - - Text inside the button. Only required if `type` is a `link`. - - - - - - - Array of version names. Only use this if you want to show different versions - of docs with a dropdown in the navigation bar. - - - - An array of the anchors, includes the `icon`, `color`, and `url`. - - - The [Font Awesome](https://fontawesome.com/search?q=heart) icon used to feature the anchor. - - Example: `comments` - - - The name of the anchor label. - - Example: `Community` - - - The start of the URL that marks what pages go in the anchor. Generally, this is the name of the folder you put your pages in. - - - The hex color of the anchor icon background. Can also be a gradient if you pass an object with the properties `from` and `to` that are each a hex color. - - - Used if you want to hide an anchor until the correct docs version is selected. - - - Pass `true` if you want to hide the anchor until you directly link someone to docs inside it. - - - One of: "brands", "duotone", "light", "sharp-solid", "solid", or "thin" - - - - - - - Override the default configurations for the top-most anchor. - - - The name of the top-most anchor - - - Font Awesome icon. - - - One of: "brands", "duotone", "light", "sharp-solid", "solid", or "thin" - - - - - - An array of navigational tabs. - - - The name of the tab label. - - - The start of the URL that marks what pages go in the tab. Generally, this - is the name of the folder you put your pages in. - - - - - - Configuration for API settings. Learn more about API pages at [API Components](/api-playground/demo). - - - The base url for all API endpoints. If `baseUrl` is an array, it will enable for multiple base url - options that the user can toggle. - - - - - - The authentication strategy used for all API endpoints. - - - The name of the authentication parameter used in the API playground. - - If method is `basic`, the format should be `[usernameName]:[passwordName]` - - - The default value that's designed to be a prefix for the authentication input field. - - E.g. If an `inputPrefix` of `AuthKey` would inherit the default input result of the authentication field as `AuthKey`. - - - - - - Configurations for the API playground - - - - Whether the playground is showing, hidden, or only displaying the endpoint with no added user interactivity `simple` - - Learn more at the [playground guides](/api-playground/demo) - - - - - - Enabling this flag ensures that key ordering in OpenAPI pages matches the key ordering defined in the OpenAPI file. - - This behavior will soon be enabled by default, at which point this field will be deprecated. - - - - - - - A string or an array of strings of URL(s) or relative path(s) pointing to your - OpenAPI file. - - Examples: - - ```json Absolute - "openapi": "https://example.com/openapi.json" - ``` - ```json Relative - "openapi": "/openapi.json" - ``` - ```json Multiple - "openapi": ["https://example.com/openapi1.json", "/openapi2.json", "/openapi3.json"] - ``` - - - - - - An object of social media accounts where the key:property pair represents the social media platform and the account url. - - Example: - ```json - { - "x": "https://x.com/mintlify", - "website": "https://mintlify.com" - } - ``` - - - One of the following values `website`, `facebook`, `x`, `discord`, `slack`, `github`, `linkedin`, `instagram`, `hacker-news` - - Example: `x` - - - The URL to the social platform. - - Example: `https://x.com/mintlify` - - - - - - Configurations to enable feedback buttons - - - - Enables a button to allow users to suggest edits via pull requests - - - Enables a button to allow users to raise an issue about the documentation - - - - - - Customize the dark mode toggle. - - - Set if you always want to show light or dark mode for new users. When not - set, we default to the same mode as the user's operating system. - - - Set to true to hide the dark/light mode toggle. You can combine `isHidden` with `default` to force your docs to only use light or dark mode. For example: - - - ```json Only Dark Mode - "modeToggle": { - "default": "dark", - "isHidden": true - } - ``` - - ```json Only Light Mode - "modeToggle": { - "default": "light", - "isHidden": true - } - ``` - - - - - - - - - A background image to be displayed behind every page. See example with - [Infisical](https://infisical.com/docs) and [FRPC](https://frpc.io). - diff --git a/index.mdx b/index.mdx new file mode 100644 index 0000000..96f5460 --- /dev/null +++ b/index.mdx @@ -0,0 +1,106 @@ +--- +title: "FlexyPe Documentation" +description: "Complete guide to FlexyPe products: Checkout, Pass, and API" +--- + +# Welcome to FlexyPe Documentation + +FlexyPe provides powerful tools to increase conversions, customer engagement, and revenue. Choose your product below to get started. + +## Our Products + + + + 1-click checkout solution built for Shopify. Reduce cart abandonment and boost conversions. + + + + Digital wallet and loyalty solution. Create branded passes and loyalty programs. + + + + RESTful API for programmatic access to FlexyPe features and data. + + + +## Quick Start + +### New to FlexyPe? + +Start with [Checkout Getting Started](/checkout/getting-started/onboarding) to set up your store in minutes. + +### Looking for Dashboard Help? + +Visit the [Dashboard Handbook](/checkout/features/dashboard) for detailed configuration guides. + +### Integrating with Our API? + +Check out the [API Documentation](/api/overview) for endpoints and webhooks. + +## Documentation Structure + +Our documentation is organized by product with consistent sections: + +- **Getting Started**: Setup and basic concepts +- **Features/Guides**: Detailed feature documentation +- **Integrations**: Third-party service connections +- **Settings**: Configuration and account management +- **API Reference**: Technical reference and endpoints + +## Popular Topics + + + + Connect popular payment providers to your checkout + + + + Recover lost sales with abandoned cart follow-up + + + + Create and manage promotions and discount codes + + + + Customize the checkout experience to match your brand + + + +## Need Help? + +- **Email Support**: [hello@flexype.io](mailto:hello@flexype.io) +- **Website**: [flexype.io](https://flexype.io) +- **Blog**: [flexype.io/blogs](https://flexype.io/blogs) + +--- + +**Last Updated**: November 2024 diff --git a/pass/getting-started/setup.mdx b/pass/getting-started/setup.mdx new file mode 100644 index 0000000..93c4040 --- /dev/null +++ b/pass/getting-started/setup.mdx @@ -0,0 +1,113 @@ +--- +title: "Pass Setup Guide" +description: "Get started with FlexyPe Pass in minutes" +--- + +# Getting Started with FlexyPe Pass + +This guide walks you through the initial setup of FlexyPe Pass. + +## Prerequisites + +- Active FlexyPe account +- Shopify store (Pro plan or higher recommended) +- Access to store branding assets (logo, colors) + +## Step 1: Enable Pass + +1. Log in to your [FlexyPe Dashboard](https://dashboard.flexype.io) +2. Go to **Products** or **Settings** +3. Find **Pass** in the products list +4. Click **Enable** or **Activate** + +## Step 2: Configure Basic Settings + +### Store Branding + +1. Navigate to **Pass Settings** → **Branding** +2. Upload your store logo (recommended: 1000x1000px, PNG/JPG) +3. Set primary brand color (e.g., #2f72ff) +4. Add store name and description + +### Default Pass Design + +1. Choose a pass template +2. Customize colors and fonts +3. Add your logo and branding +4. Preview the pass in Apple/Google Wallet + +## Step 3: Create Your First Pass + +1. Go to **Passes** → **Create Pass** +2. Choose a pass type: + - **Loyalty Card**: Track rewards and points + - **Coupon**: Limited-time offers + - **Membership**: Subscription-based access + - **Event Ticket**: Time-limited events + +3. Configure the pass details: + - **Title**: Pass name visible to customers + - **Description**: What the pass is for + - **Expiration**: When the pass expires + - **Primary Field**: Key metric (e.g., Points Balance) + +4. Set up pass actions: + - Deep links to your store + - Update notifications + - External URLs + +5. Click **Create Pass** + +## Step 4: Distribute Your Pass + +### Method 1: Checkout Integration + +1. Enable Pass in your checkout flow +2. Customers receive passes upon purchase + +### Method 2: URL Sharing + +1. Go to **Passes** → Select your pass +2. Click **Share** to get distribution URL +3. Share the URL via: + - Email campaigns + - Social media + - Website QR code + +### Method 3: Direct Link + +Embed pass links in your website: +```html + + Add to Wallet + +``` + +## Step 5: Test Your Pass + +1. Click **Preview** on your pass +2. Use your phone camera to scan the QR code +3. Add the pass to your Apple/Google Wallet +4. Verify appearance and functionality + +## Next Steps + +- Learn more about [pass customization](../guides/customization) +- Set up [loyalty programs](../guides/loyalty-programs) +- Configure [analytics and tracking](../guides/analytics) + +## Troubleshooting + +### Pass won't show in Apple Wallet +- Check compatibility: iOS 6+ for Apple Wallet +- Verify pass hasn't expired +- Ensure logo dimensions are correct + +### Google Wallet Not Available +- Check if Pass is supported in your region +- Update Google Wallet app to latest version +- Verify pass follows Google specifications + +### Need Help? + +Contact support at [hello@flexype.io](mailto:hello@flexype.io) diff --git a/pass/introduction.mdx b/pass/introduction.mdx new file mode 100644 index 0000000..fd3c24a --- /dev/null +++ b/pass/introduction.mdx @@ -0,0 +1,50 @@ +--- +title: "Introduction" +description: "Welcome to FlexyPe Pass - Digital Wallet and Loyalty Solution" +--- + +# FlexyPe Pass + +Welcome to FlexyPe Pass! Transform your customer engagement and drive repeat purchases with our digital wallet and loyalty solution. + +## What is FlexyPe Pass? + +FlexyPe Pass is a powerful digital wallet and loyalty solution that enables you to create branded pass experiences for your customers. It integrates seamlessly with Apple Wallet and Google Wallet, allowing your customers to access offers, loyalty programs, and digital assets directly from their mobile devices. + +## Our Mission + +We're committed to helping businesses strengthen customer relationships and increase lifetime value by: + +- **Creating Engagement**: Digital passes that customers actually want to use +- **Building Loyalty**: Rewarding repeat purchases and customer engagement +- **Enhancing Experience**: Seamless integration with customer wallets +- **Driving Revenue**: Increase repeat purchases and customer lifetime value +- **Making it Simple**: Easy setup and management without technical complexity + +## Why Choose FlexyPe Pass? + +📱 **Mobile-First** - Apple Wallet & Google Wallet integration + +🎁 **Loyalty Programs** - Create custom rewards and loyalty programs + +🎨 **Branded Experience** - Fully customizable pass design + +📊 **Analytics** - Track pass usage and customer engagement + +🔄 **Easy Management** - Simple interface to create and manage passes + +📧 **Customer Reach** - Send passes directly to customer devices + +## What You'll Learn + +In this documentation, you'll discover: + +- How to set up FlexyPe Pass in your Shopify store +- Creating and managing digital passes +- Building customer loyalty programs +- Tracking and optimizing pass performance +- Best practices for customer engagement + +## Getting Started + +Let's help you build a loyal customer base and increase repeat purchases! diff --git a/pass/overview.mdx b/pass/overview.mdx new file mode 100644 index 0000000..c9fab2d --- /dev/null +++ b/pass/overview.mdx @@ -0,0 +1,35 @@ +--- +title: "Overview" +description: "Learn about FlexyPe Pass and its features" +--- + +# FlexyPe Pass + +FlexyPe Pass is our digital wallet and loyalty solution designed to enhance customer engagement and repeat purchases. + +## What is FlexyPe Pass? + +FlexyPe Pass allows you to create a branded digital wallet experience for your customers, enabling: + +- Digital pass creation and management +- Customer loyalty programs +- Exclusive offers and promotions +- Seamless integration with your store + +## Key Features + +- **Digital Wallet Integration**: Apple Wallet and Google Wallet support +- **Loyalty Programs**: Create custom loyalty and rewards programs +- **Pass Management**: Create, distribute, and track digital passes +- **Analytics**: Comprehensive pass usage analytics +- **Customer Engagement**: Increase repeat purchases and customer lifetime value + +## Getting Started + +- **[Setup Guide](./getting-started/setup)**: Get Pass up and running +- **[Creating Passes](./guides/creating-passes)**: Learn how to create digital passes +- **[Loyalty Programs](./guides/loyalty-programs)**: Set up customer loyalty + +## Need Help? + +For support and questions, contact us at [hello@flexype.io](mailto:hello@flexype.io). diff --git a/settings/overview.mdx b/settings/overview.mdx deleted file mode 100644 index 5c9cd3d..0000000 --- a/settings/overview.mdx +++ /dev/null @@ -1,78 +0,0 @@ ---- -title: "Settings Overview" -description: "Configure your store, payments, taxes, integrations, and permissions — all from one place." ---- - -The **Settings** section is your administrative control center within FlexyPe, ensuring smooth checkout operations from business details to API integrations. - -## Settings Areas - - - - Add business name, contacts, and brand details for consistent identity. - - - - Set gateways, modes, and GST fields for accurate processing. - - - - Configure tax rules and duties for compliance and pricing. - - - - Connect analytics and tracking for conversion insights. - - - - Manage credentials for secure backend communication. - - - - Control admin access and monitor team activity. - - - - Review audit trails for accountability. - - - - Update credentials for enhanced security. - - - -## Frequently Asked Questions - - - - Navigate to [Payment Settings](/settings/payments), select your provider (e.g., Razorpay), enter API keys, and test a transaction. This ensures seamless UPI and wallet support. - - - - In [Taxes & Duties](/settings/taxesandduties), add GSTIN, set inclusive/exclusive pricing, and define regional rules. Automate for international duties to stay compliant. - - - - Go to [Ads & Integrations](/settings/integrations), add Google Analytics or Meta Pixel codes, and track checkout events. Use webhooks for CRM sync. - - - - Use [Users & Permissions](/settings/usersandpermissions) to assign roles like Admin or Analyst, limit modules, and review [Activity Logs](/settings/activitylogs) for oversight. - - - - Generate keys in [API Keys](/settings/apikeys), rotate regularly, and revoke if compromised. Monitor usage via logs for anomalies. - - - -## Need Help? - - - - Get in touch with our support team - - - - Explore our developer documentation - - \ No newline at end of file From 21fd70447cf901ac553749c4cccb26e90ec138a1 Mon Sep 17 00:00:00 2001 From: Roshan Kumar Chatei Date: Tue, 4 Nov 2025 16:02:11 +0530 Subject: [PATCH 2/3] updated content --- checkout/overview.mdx | 88 ++++++++++++++++--- index.mdx | 199 ++++++++++++++++++++++++++++++------------ 2 files changed, 221 insertions(+), 66 deletions(-) diff --git a/checkout/overview.mdx b/checkout/overview.mdx index 2e99306..5a60567 100644 --- a/checkout/overview.mdx +++ b/checkout/overview.mdx @@ -1,7 +1,7 @@ --- title: "Overview" mode: "wide" -description: "Your complete guide to mastering the FlexyPe Checkout Dashboard" +description: "Your complete guide to mastering the FlexyPe Checkout" --- Get started with FlexyPe's powerful checkout platform. Everything you need to optimize conversions, reduce RTO, and scale your e-commerce business. @@ -9,43 +9,99 @@ Get started with FlexyPe's powerful checkout platform. Everything you need to op ## Core Features - + Monitor your store's performance with real-time analytics and insights - + Recover lost sales with automated cart recovery campaigns - + Configure shipping zones, rates, and delivery options - + Create payment-specific discounts to boost conversions - + Increase AOV with pre and post-purchase upsell offers - + Reduce return-to-origin rates with AI-powered verification - + Create versatile discount campaigns and promotional offers - + Customize your checkout to match your brand identity - + Configure store, payments, integrations, and team access +## Payment Integrations + +Connect your preferred payment providers to accept payments globally. + + + + Accept payments in India with Razorpay + + + + Easebuzz payment gateway integration + + + + Cashfree payment solutions + + + + PayU payment gateway integration + + + + XPay payment integration + + + + PhonePe business payments + + + + SnapMint buy now pay later + + + + CC Avenue payment gateway + + + +## Analytics Integrations + +Track and measure checkout performance with leading analytics platforms. + + + + Track conversions and ROI on Meta platforms + + + + Monitor Google Ads campaign performance + + + + Complete checkout analytics and user behavior tracking + + + ## Popular Guides @@ -64,16 +120,24 @@ Get started with FlexyPe's powerful checkout platform. Everything you need to op The Abandoned Cart dashboard shows all incomplete checkouts. Enable automated recovery emails and SMS to bring customers back. + + + We support 8+ payment providers including Razorpay, Easebuzz, Cashfree, PayU, XPay, PhonePe, SnapMint, and CC Avenue. Check the Payment Integrations section to set up your preferred gateway. + + + + Integrate with Meta, Google Ads, or Google Analytics to track conversions, user behavior, and ROI on your checkout. + ## Need Help? - + Get in touch with our support team - + Explore our developer documentation diff --git a/index.mdx b/index.mdx index 96f5460..3ae1340 100644 --- a/index.mdx +++ b/index.mdx @@ -3,11 +3,15 @@ title: "FlexyPe Documentation" description: "Complete guide to FlexyPe products: Checkout, Pass, and API" --- -# Welcome to FlexyPe Documentation +# FlexyPe Documentation -FlexyPe provides powerful tools to increase conversions, customer engagement, and revenue. Choose your product below to get started. +Complete, up-to-date documentation for all FlexyPe products. Learn how to boost conversions, drive customer engagement, and scale your e-commerce business. -## Our Products +--- + +## Get Started in Minutes + +Choose your product and dive into our comprehensive guides. - 1-click checkout solution built for Shopify. Reduce cart abandonment and boost conversions. + Fast, flexible 1-click checkout for Shopify. Reduce cart abandonment and maximize conversion rates. - Digital wallet and loyalty solution. Create branded passes and loyalty programs. + Digital wallet and customer loyalty platform. Drive repeat purchases and engagement. - RESTful API for programmatic access to FlexyPe features and data. + Powerful REST API for programmatic access to all FlexyPe features and data. -## Quick Start - -### New to FlexyPe? - -Start with [Checkout Getting Started](/checkout/getting-started/onboarding) to set up your store in minutes. - -### Looking for Dashboard Help? - -Visit the [Dashboard Handbook](/checkout/features/dashboard) for detailed configuration guides. - -### Integrating with Our API? - -Check out the [API Documentation](/api/overview) for endpoints and webhooks. - -## Documentation Structure - -Our documentation is organized by product with consistent sections: - -- **Getting Started**: Setup and basic concepts -- **Features/Guides**: Detailed feature documentation -- **Integrations**: Third-party service connections -- **Settings**: Configuration and account management -- **API Reference**: Technical reference and endpoints - -## Popular Topics +--- - - - Connect popular payment providers to your checkout - +## Quick Setup Guides + - Recover lost sales with abandoned cart follow-up + Deploy your checkout in minutes with our step-by-step setup guide. - Create and manage promotions and discount codes + Create and manage branded digital passes for your customers. - Customize the checkout experience to match your brand + Access comprehensive API documentation and integration guides. -## Need Help? +--- + +## What is FlexyPe? + +FlexyPe is a comprehensive e-commerce platform designed to help Shopify merchants maximize revenue, reduce friction, and build lasting customer relationships. We provide three powerful products that work together seamlessly to transform your online business. + +Our platform is built on the principle that every interaction with your customer matters. From the moment they begin checkout to their journey as a loyal repeat customer, FlexyPe optimizes every touchpoint with data-driven insights and battle-tested features. + +--- + +## Checkout: Convert More, Abandon Less + +**[Explore Checkout →](/checkout/introduction)** + +In today's competitive e-commerce landscape, checkout abandonment is one of the biggest revenue drains. FlexyPe Checkout solves this with a lightning-fast, frictionless 1-click checkout experience built specifically for Shopify stores. + +Our checkout solution combines intelligent design with powerful conversion optimization tools. Monitor real-time performance through your dashboard, recover abandoned carts with automated campaigns, and leverage advanced features like dynamic discounts, smart upsells, and fraud detection. With support for 8+ payment providers and seamless integration with your favorite analytics platforms, you get complete control and visibility. + +**Key capabilities include:** +- Real-time performance monitoring and analytics +- Intelligent abandoned cart recovery system +- Flexible discount and promotion engine (coupons, payment offers, bundles) +- Advanced risk management with RTO Suite +- Complete checkout customization to match your brand +- Multi-provider payment integration ecosystem +- Comprehensive team management and access controls + +Whether you're optimizing for conversions or managing complex fulfillment operations, Checkout gives you the tools to understand your customers and grow your revenue. + +--- + +## Pass: Build Customer Loyalty + +**[Explore Pass →](/pass/introduction)** + +In an era where customer acquisition costs continue to rise, retention is your competitive advantage. FlexyPe Pass empowers you to create branded digital wallet experiences that drive repeat purchases and deepen customer relationships. + +Pass transforms how customers interact with your brand by meeting them where they already are—in their digital wallets. Create mobile passes that customers actually want to save, build loyalty programs that reward engagement, and gain direct access to your most valuable customers. With support for both Apple Wallet and Google Wallet, your loyalty initiatives reach customers across all devices. + +Pass isn't just another loyalty program—it's a direct channel to your customers that encourages repeat visits and increases lifetime value. + +--- + +## API: Build Custom Solutions -- **Email Support**: [hello@flexype.io](mailto:hello@flexype.io) +**[Explore API →](/api/introduction)** + +For developers and enterprises, FlexyPe provides a comprehensive REST API that exposes the full power of our platform. Build custom integrations, automate your workflows, and create bespoke solutions tailored to your unique business needs. + +Our API is designed with developer experience in mind. Clean, intuitive endpoints, comprehensive webhook support for real-time events, and extensive documentation make integration straightforward. Whether you're building internal tools, connecting third-party systems, or creating entirely new applications, the FlexyPe API provides a foundation for innovation. + +--- + +## Why Choose FlexyPe? + +**Proven Performance** - Built by e-commerce experts with years of experience optimizing checkout flows and maximizing revenue. + +**Integrated Ecosystem** - All three products work together seamlessly, providing a unified platform for growth rather than disconnected point solutions. + +**Merchant-First Design** - Every feature is designed with real merchant needs in mind, backed by extensive research and customer feedback. + +**Enterprise Grade** - Scalability, reliability, and security built in from day one. We power stores of all sizes, from startups to high-volume operations. + +**Comprehensive Documentation** - Detailed guides, clear examples, and expert support help you get the most from FlexyPe. + +--- + +## Getting Started + +Choose your journey: + +- **Ready to boost conversions?** Start with [Checkout Setup](/checkout/getting-started/onboarding) +- **Want to build loyalty?** Explore [Pass Capabilities](/pass/introduction) +- **Need to integrate?** Check out the [API Documentation](/api/introduction) + +--- + +## Release Notes + +Stay informed about the latest features, improvements, and updates. [View Changelog →](/changelog/index) + +--- + +## Support & Resources + +We're here to help you succeed. + +- **Email**: [hello@flexype.io](mailto:hello@flexype.io) - **Website**: [flexype.io](https://flexype.io) - **Blog**: [flexype.io/blogs](https://flexype.io/blogs) --- -**Last Updated**: November 2024 +## About FlexyPe + +### Our Mission + +To empower e-commerce merchants with technology that drives growth, reduces friction, and builds customer loyalty at every stage of the customer journey. + +### Who We Are + +FlexyPe is a team of dedicated e-commerce professionals, software engineers, and customer advocates. We understand the challenges that Shopify merchants face—rising customer acquisition costs, checkout abandonment, competitive pressure, and the need to scale operations efficiently. + +### What We Believe + +We believe that great technology should be: + +**Intuitive** - Powerful features shouldn't require a PhD to implement. Our platform is designed for merchants, by merchants who understand your business. + +**Integrated** - Point solutions create more problems than they solve. We've built a comprehensive ecosystem where checkout, loyalty, and APIs work in harmony. + +**Data-Driven** - Every decision you make should be backed by data. FlexyPe provides the insights you need to optimize, test, and improve continuously. + +**Reliable** - Your business can't afford downtime. We maintain enterprise-grade infrastructure with redundancy, monitoring, and proactive support. + +**Transparent** - Success metrics should be clear. We help you track what matters and show you the ROI of using FlexyPe. + +### Our Commitment + +Our success is measured by your success. Every feature we build, every improvement we make, and every support interaction we have is guided by one principle: **How can we help you grow?** + +We're committed to continuous innovation, regular updates, and unwavering customer support. When you choose FlexyPe, you're partnering with a team that's invested in your long-term success. + +--- + +**Last Updated**: November 2024 | **Documentation Version**: 2.0 From 04fd2fe97063064c418dfc42a7a0503d76eff670 Mon Sep 17 00:00:00 2001 From: Roshan Kumar Chatei Date: Tue, 4 Nov 2025 16:03:47 +0530 Subject: [PATCH 3/3] updated docs --- docs-n.json | 174 ++++++++++++++++++++++++++++++++++++++++++++++++++++ docs.json | 22 ------- 2 files changed, 174 insertions(+), 22 deletions(-) create mode 100644 docs-n.json diff --git a/docs-n.json b/docs-n.json new file mode 100644 index 0000000..ceeb6a5 --- /dev/null +++ b/docs-n.json @@ -0,0 +1,174 @@ +{ + "$schema": "https://mintlify.com/docs.json", + "theme": "mint", + "name": "FlexyPe", + "description": "Simple 1-click checkout built for Shopify. Boost conversions with a seamless, high-converting experience", + "favicon": "/flexy-favicon.svg", + "logo": { + "light": "/logo/flexy-light.svg", + "dark": "/logo/flexy-dark.svg" + }, + "appearance": { + "default": "system" + }, + "colors": { + "primary": "#2f72ff", + "light": "#5c94ff", + "dark": "#255acc" + }, + "background": { + "decoration": "grid" + }, + "navigation": { + "tabs": [ + { + "tab": "Checkout", + "groups": [ + { + "group": "Get Started", + "pages": ["checkout/introduction", "checkout/overview", "checkout/getting-started/onboarding"] + }, + { + "group": "Features", + "pages": [ + "checkout/features/dashboard", + "checkout/features/abandoned-cart", + "checkout/features/shipping", + { + "group": "Coupons", + "pages": [ + "checkout/features/coupons/amount-off-products-order-discount", + "checkout/features/coupons/buy-x-get-y", + "checkout/features/coupons/purchase-driven", + "checkout/features/coupons/exclusive-free-gift", + "checkout/features/coupons/free-shipping", + "checkout/features/coupons/bundle" + ] + }, + "checkout/features/payment-offers", + "checkout/features/upsell", + { + "group": "Customization", + "pages": ["checkout/features/customizations/general", "checkout/features/customizations/login", "checkout/features/customizations/address", "checkout/features/customizations/payments"] + }, + "checkout/features/rto-suite", + { + "group": "Settings", + "pages": [ + "checkout/features/settings/store-details", + "checkout/features/settings/payments", + "checkout/features/settings/taxes-and-duties", + "checkout/features/settings/integrations", + "checkout/features/settings/api-keys", + "checkout/features/settings/users-and-permissions", + "checkout/features/settings/activity-logs", + "checkout/features/settings/change-password" + ] + } + ] + }, + { + "group": "Integrations", + "pages": [ + { + "group": "Payment Providers", + "pages": [ + "checkout/integrations/payment/razorpay", + "checkout/integrations/payment/easebuzz", + "checkout/integrations/payment/cashfree", + "checkout/integrations/payment/payu", + "checkout/integrations/payment/xpay", + "checkout/integrations/payment/phonepe", + "checkout/integrations/payment/snapmint", + "checkout/integrations/payment/cc-avenue" + ] + }, + { + "group": "Analytics", + "pages": ["checkout/integrations/analytics/meta", "checkout/integrations/analytics/google-ads", "checkout/integrations/analytics/google-analytics"] + } + ] + } + ] + }, + + { + "tab": "Pass", + "groups": [ + { + "group": "Get Started", + "pages": ["pass/introduction", "pass/overview"] + } + ] + }, + + { + "tab": "API", + "groups": [ + { + "group": "Get Started", + "pages": ["api/introduction", "api/overview"] + }, + { + "group": "Endpoints", + "pages": [ + "api/endpoints/endpoint/create", + "api/endpoints/endpoint/get", + "api/endpoints/endpoint/delete" + ] + }, + { + "group": "Webhooks", + "pages": ["api/webhooks/acr"] + } + ] + }, + + { + "tab": "Changelog", + "groups": [ + { + "group": "Release Notes", + "pages": ["changelog/index"] + } + ] + } + ], + "global": { + "anchors": [ + { + "anchor": "Website", + "href": "https://flexype.io", + "icon": "globe" + }, + { + "anchor": "Blog", + "href": "https://flexype.io/blogs", + "icon": "newspaper" + } + ] + } + }, + "navbar": { + "links": [ + { + "label": "Support", + "href": "mailto:hello@flexype.io" + } + ], + "primary": { + "type": "button", + "label": "Dashboard", + "href": "https://dashboard.flexype.io" + } + }, + "footer": { + "socials": { + "x": "https://x.com/FlexyPe", + "linkedin": "https://linkedin.com/company/flexype" + } + }, + "contextual": { + "options": ["chatgpt", "claude", "perplexity", "mcp", "copy"] + } +} diff --git a/docs.json b/docs.json index ceeb6a5..675e361 100644 --- a/docs.json +++ b/docs.json @@ -92,31 +92,9 @@ ] }, - { - "tab": "Pass", - "groups": [ - { - "group": "Get Started", - "pages": ["pass/introduction", "pass/overview"] - } - ] - }, - { "tab": "API", "groups": [ - { - "group": "Get Started", - "pages": ["api/introduction", "api/overview"] - }, - { - "group": "Endpoints", - "pages": [ - "api/endpoints/endpoint/create", - "api/endpoints/endpoint/get", - "api/endpoints/endpoint/delete" - ] - }, { "group": "Webhooks", "pages": ["api/webhooks/acr"]