Merge pull request #374 from amit-webkul/docs-fixes

Doc Update

docs/.vuepress/theme/components/NavLinks.vue

@@ -31,11 +31,34 @@
       <OutboundLink />
     </a>
 
-    <div class="nav-item" v-if="$route.path.split('/')[1] !== ''">
-      <select v-model="version" @change="changeVersion">
-        <option value="1.x">1.x</option>
-        <option value="1.5.x">1.5.x</option>
-        <option value="2.x">2.x</option>
+    <div
+      class="nav-item"
+      v-if="$route.path.split('/')[1] !== ''"
+    >
+      <select
+        v-model="version"
+        @change="changeVersion"
+      >
+        <option
+          value="1.x"
+          :selected="version === '1.x'"
+        >
+          1.x
+        </option>
+
+        <option
+          value="1.5.x"
+          :selected="version === '1.5.x'"
+        >
+          1.5.x
+        </option>
+
+        <option
+          value="2.x"
+          :selected="version === '2.x'"
+        >
+          2.x
+        </option>
       </select>
     </div>
   </nav>

docs/.vuepress/version-configs/2.x.js

@@ -67,7 +67,8 @@ module.exports = [
             ['packages/validation', 'Validation'],
             ['packages/datagrid', 'DataGrid'],
             ['packages/create-acl', 'Access Control List'],
-            ['packages/create-custom-configuration', 'Custom Configuration']
+            ['packages/create-custom-configuration', 'Custom Configuration'],
+            ['packages/create-data-import', 'Data Transfer']
         ])
     },
     {
@@ -94,8 +95,15 @@ module.exports = [
         children: setVersionPrefix([
             ['themes/create-theme', 'Store Theme'],
             ['themes/create-admin-theme', 'Admin Theme'],
-            ['themes/notification', 'Real Time Notification'],
-            ['themes/integrate-image-search-in-theme', 'Image Search']
+        ])
+    },
+    {
+        title: 'Features',
+        path: setVersionPrefix('features'),
+        collapsable: true,
+        children: setVersionPrefix([
+            ['features/notification', 'Real Time Notification'],
+            ['features/integrate-image-search-in-theme', 'Image Search']
         ])
     },
     {

docs/1.5.x/advanced/create-payment-method.md

@@ -51,26 +51,26 @@ To create a payment method package, follow these commands in the Bagisto root di
 
     return [
         [
-            'key'    => 'sales.paymentmethods.stripe',
+            'key'    => 'sales.payment_methods.stripe',
             'name'   => 'Stripe',
-            'sort'   => 1,
+            'sort'   => 5,
             'fields' => [
                 [
                     'name'          => 'title',
-                    'title'         => 'admin::app.admin.system.title',
+                    'title'         => 'Title',
                     'type'          => 'text',
                     'validation'    => 'required',
                     'channel_based' => false,
                     'locale_based'  => true,
                 ], [
                     'name'          => 'description',
-                    'title'         => 'admin::app.admin.system.description',
+                    'title'         => 'Description',
                     'type'          => 'textarea',
                     'channel_based' => false,
                     'locale_based'  => true,
                 ], [
                     'name'          => 'active',
-                    'title'         => 'admin::app.admin.system.status',
+                    'title'         => 'Status',
                     'type'          => 'boolean',
                     'validation'    => 'required',
                     'channel_based' => false,
@@ -168,7 +168,7 @@ To create a payment method package, follow these commands in the Bagisto root di
         protected function registerConfig()
         {
             $this->mergeConfigFrom(
-                dirname(__DIR__) . '/Config/paymentmethods.php', 'paymentmethods'
+                dirname(__DIR__) . '/Config/paymentmethods.php', 'payment_methods'
             );
 
             $this->mergeConfigFrom(

docs/2.x/advanced/create-payment-method.md

@@ -80,10 +80,10 @@ To create a payment method package, follow these commands in the Bagisto root di
         ]
     ];
     ```
-    - **`key`**: A unique value for the configuration, concatenated with a dot (`.`) operator.
-    - **`name`**: The placeholder value for the configuration. It is recommended to use translations in Bagisto.
-    - **`sort`**: The position of the configuration menu.
-    - **`fields`**: An array containing the custom configurations and fields for the payment method. The example includes three arrays for **`title`**, **`description`**, and **`status`**. You can add more arrays for additional settings.
+    - **key** : A unique value for the configuration, concatenated with a dot (`.`) operator.
+    - **name** : The placeholder value for the configuration. It is recommended to use translations in Bagisto.
+    - **sort** : The position of the configuration menu.
+    - **fields** : An array containing the custom configurations and fields for the payment method. The example includes three arrays for **`title`**, **`description`**, and **`status`**. You can add more arrays for additional settings.
 
 3. In the **`paymentmethods.php`** file, add the following content:
 
@@ -101,12 +101,12 @@ To create a payment method package, follow these commands in the Bagisto root di
         ],
     ];
     ```
-    - **`code`**: A text representing the payment method.
-    - **`title`**: The name of the payment method.
-    - **`description`**: A brief description of the payment method.
-    - **`class`**: The namespace of the class where the payment method functions are defined.
-    - **`active`**: A boolean value (`true` or `false`) to enable or disable the module.
-    - **`sort`**: The position of the payment method.
+    - **code** : A text representing the payment method.
+    - **title** : The name of the payment method.
+    - **description** : A brief description of the payment method.
+    - **class** : The namespace of the class where the payment method functions are defined.
+    - **active** : A boolean value (`true` or `false`) to enable or disable the module.
+    - **sort** : The position of the payment method.
 
 4. In the **`Stripe.php`** file within the **`Payment`** directory, add the following code:
 
@@ -168,11 +168,13 @@ To create a payment method package, follow these commands in the Bagisto root di
         protected function registerConfig()
         {
             $this->mergeConfigFrom(
-                dirname(__DIR__) . '/Config/paymentmethods.php', 'payment_methods'
+                dirname(__DIR__) . '/Config/paymentmethods.php',
+                'payment_methods'
             );
 
             $this->mergeConfigFrom(
-                dirname(__DIR__) . '/Config/system.php', 'core'
+                dirname(__DIR__) . '/Config/system.php',
+                'core'
             );
         }
     }

docs/2.x/advanced/create-product-type.md

@@ -14,7 +14,7 @@ To create a new product type in Bagisto, follow these steps:
 
 1. Create your own package. If you need assistance with package development, you can refer to the [Package Development](../packages) section.
 
-2. Inside the **Config** folder of your package, create a file named **`product_types.php`**.
+2. Inside the **`Config`** folder of your package, create a file named **`product_types.php`**.
 
 3. Add the following code to the **`product_types.php`** file. This code will define the new product type and its properties:
 
@@ -54,7 +54,8 @@ To create a new product type in Bagisto, follow these steps:
            //...
 
            $this->mergeConfigFrom(
-               dirname(__DIR__) . '/Config/product_types.php', 'product_types'
+               dirname(__DIR__) . '/Config/product_types.php',
+               'product_types'
            );
        }
    }

docs/2.x/advanced/create-shipping-method.md

@@ -54,13 +54,13 @@ Alternatively, you can manually set up all the files for your shipping method pa
    ];
    ```
 
-   - **code**: A unique value used to refer to the particular shipping method.
-   - **title**: The label or name displayed in the user interface.
-   - **description**: Information about your shipping method.
-   - **active**: Enable or disable option for the shipping method.
-   - **default_rate**: The default rate value.
-   - **type**: Specifies whether the shipping method applies per unit or per order.
-   - **class**: The path and filename of the shipping method class (**`namespace\package-name\Carriers-folder\filename`**).
+   - **code** : A unique value used to refer to the particular shipping method.
+   - **title** : The label or name displayed in the user interface.
+   - **description** : Information about your shipping method.
+   - **active** : Enable or disable option for the shipping method.
+   - **default_rate** : The default rate value.
+   - **type** : Specifies whether the shipping method applies per unit or per order.
+   - **class** : The path and filename of the shipping method class (**`namespace\package-name\Carriers-folder\filename`**).
 
 3. Create a **`Carriers`** folder inside the **`src`** folder. Then, create a **`Blog.php`** file inside the **`Carriers`** folder.
 
@@ -237,11 +237,13 @@ Alternatively, you can manually set up all the files for your shipping method pa
         public function register()
         {
             $this->mergeConfigFrom(
-                dirname(__DIR__) . '/Config/carriers.php', 'carriers'
+                dirname(__DIR__) . '/Config/carriers.php',
+                'carriers'
             );
 
             $this->mergeConfigFrom(
-                dirname(__DIR__) . '/Config/system.php', 'core'
+                dirname(__DIR__) . '/Config/system.php',
+                'core'
             );
         }
     }

docs/2.x/architecture/frontend.md

@@ -12,4 +12,4 @@ In **tailwind.config.js** file, just define your blade file path along with .js
 
 # Blade
 
-**Bagisto** uses blade template engine that is included with **Laravel**. It does not restrict you from using plain PHP code in your templates. This [documentation](https://devdocs.bagisto.com/2.x/packages/views.html#directory-structure) provides an explanation of directory structure and package configuration for implementations.
+**Bagisto** utilizes the Blade template engine, which comes integrated with **Laravel**. It allows flexibility by permitting the use of both Blade components and plain PHP code within templates. This versatility empowers developers to craft dynamic and efficient solutions. For further insights into Bagisto's directory structure and package configuration, refer to the [documentation](https://devdocs.bagisto.com/2.x/packages/views.html#directory-structure).

docs/2.x/architecture/packages.md

@@ -7,5 +7,10 @@
 - Cart
 - Checkout
 - Payment
+- DataTransfer
+- MagicAI
+- SocialShare
+- SocialLogin
+- Shop
 
 Service provider enables features such as loading [routes](/1.5.x/packages/routes.html), [migrations](/1.5.x/packages/create-migrations.html), [languages](/1.5.x/packages/localization.html) or publishing [views](/1.5.x/packages/views.html), etc so **Bagisto** is developed considering these aspects.

docs/2.x/architecture/performance.md

@@ -2,7 +2,7 @@
 
 [[TOC]]
 
-In the realm of online stores, [web vitals](https://web.dev/vitals/) have become increasingly crucial. **Bagisto** prioritizes good [LCP](https://web.dev/lcp/) and [CLS](https://web.dev/cls/) to ensure an optimal user experience.
+In the realm of online stores, [web vitals](https://web.dev/vitals/) have become increasingly crucial. **Bagisto** prioritises good [LCP](https://web.dev/lcp/) and [CLS](https://web.dev/cls/) to ensure an optimal user experience.
 
 Additionally, **Bagisto** has seamlessly integrated [ElasticSearch](https://bagisto.com/en/elasticsearch-for-bagisto/) to further enhance user experience.
 

docs/2.x/architecture/theme.md

@@ -1,3 +1,9 @@
 # Theme
 
-In e-commerce businesses, themes provides an elegant way to attract users. **Bagisto** provides front-end theme i.e. **Velocity** and allow developers to create new theme as per their convenience.
+In Bagisto, we offer a default theme for the front of your online store. This theme is made to look good and work well. But we know every business has its own style. That's why you can change things from the admin panel.
+
+To change your store's theme, go to the admin panel and find the theme section. There, you'll see tools to help you change how your store looks. You can adjust colors, fonts, and layout to match your brand.
+
+I've added a link to our [Bagisto demo](https://demo.bagisto.com/) website where you can see our default theme in action. Feel free to click the link and try it out. We're always working to make things better, so your feedback is important to us. Thanks for checking out our demo!
+
+If you want to make a new theme, our [theme section](../themes) has guides for both the admin and shop. Whether you're changing your store's look or updating the admin panel, our guides will help you step by step. We want to make theme creation easy, so you can make Bagisto yours. Check out our theme section to start making your custom themes.

docs/2.x/features/README.md

@@ -0,0 +1,6 @@
+# Features
+
+Bagisto has various new features for the application of your Bagisto e-commerce store, Unlocking advanced capabilities within the Bagisto e-commerce platform becomes effortless through the creation of packages.
+
+
+By following these steps, you can create a fully customized theme for your Bagisto e-commerce store. This empowers you to create a unique and engaging shopping experience for your customers, aligning with your brand identity and enhancing your online presence.

docs/2.x/introduction/README.md

@@ -2,7 +2,7 @@
 
 ## Bagisto: A Powerful Open-Source E-Commerce Platform
 
-Bagisto is a popular open-source e-commerce platform built on the combination of the Laravel PHP framework, Vue.js, and the stylish Tailwind CSS framework. It provides a comprehensive set of tools and features to help developers and businesses create and manage their online stores effectively. With its flexible and adaptable nature, Bagisto has gained recognition and support from a growing community of users, as evidenced by its impressive 9.8K+ stars on [GitHub](https://github.com/bagisto/bagisto).
+Bagisto is a popular open-source e-commerce platform built on the combination of the Laravel PHP framework, Vue.js, and the stylish Tailwind CSS framework. It provides a comprehensive set of tools and features to help developers and businesses create and manage their online stores effectively. With its flexible and adaptable nature, Bagisto has gained recognition and support from a growing community of users, as evidenced by its impressive 8.9K+ stars on [GitHub](https://github.com/bagisto/bagisto).
 
 ## Key Features of Bagisto
 
@@ -46,6 +46,6 @@ Bagisto has a vibrant and supportive community of developers and users who activ
 
 - **Stay Updated**: Refer to the [Bagisto roadmap](https://bagisto.com/roadmap) for the latest version and recently added features.
 
-- **GitHub Repository**: Access the Bagisto repository on [GitHub](https://github.com/bagisto/bagisto) with over 9.8K+ stars, reflecting its popularity and community support.
+- **GitHub Repository**: Access the Bagisto repository on [GitHub](https://github.com/bagisto/bagisto) with over 8.9K+ stars, reflecting its popularity and community support.
 
 Join the Bagisto community today and build and manage your online store with ease.

docs/2.x/introduction/installation.md

@@ -47,26 +47,26 @@ To install Bagisto using Composer, use the following steps:
     - Follow the prompts during the installation process to provide the following details:
 
     ```
-    - Please Enter the APP URL or press enter to continue [http://localhost:8000] :
-    - Please Enter the Application Name or press enter to continue [Bagisto] : 
+    - Please Enter the APP URL :
+    - Please Enter the Application Name : 
     - Please select the default locale :
     - Please enter the default currency :
-    - Please choose the Allowed Locales using space key :
-    - Please choose the Allowed Currencies using space key :
-    - Please select the Database Connection or press enter to continue [mysql] :
-    - Please enter the Database Host or press enter to continue [127.0.0.1] :
-    - Please enter the Database Port Number or press enter to continue [3306] :
+    - Please choose the Allowed Locales for your channels :
+    - Please choose the Allowed Currencies for your channels :
+    - Please select the Database Connection :
+    - Please enter the Database Host :
+    - Please enter the Database Port Number :
     - Please enter the Database Name :
-    - Please enter the Database Prefix or press enter to continue :
+    - Please enter the Database Prefix :
     - Please enter the Database Username :
     - Please enter the Database Password :
     ```
 
-- For Create your admin credentials
+    - For Create your admin credentials
     ```
-    - Please enter the Name of Admin User or press enter to continue [Example] :
-    - Please enter the Email of Admin User or press enter to continue [[email protected]] :
-    - Please enter the Password for admin login or press enter to continue [admin123] :
+    - Enter the Name of Admin User :
+    - Enter the Email address of the Admin User :
+    - Configure the Password for admin user :
     ```
 
 ## Start Using Bagisto