user guide log, vc, category

EhfazAdnan · EhfazAdnan · commit 29bacec61f5a · 2024-12-26T15:02:26.000+06:00
diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts
@@ -50,7 +50,7 @@ export default {
     // Navbar Link
     nav: [
       { text: "Accounting", link: "/comfortaccounting/" },
-      { text: "Form", link: "/comfortform/" },
+      //{ text: "Form", link: "/comfortform/" },
     ],
     //Social Icons
     socialLinks: [
@@ -83,58 +83,61 @@ export default {
             { text: 'Code Samples', link: '/comfortaccounting/code-samples' },
           ],
         },
-        {
-          text: 'Shortcode',
-          collapsible: true,
-          items: [
-            { text: '7 Shortcodes', link: '/comfortaccounting/shortcodes' },
-          ],
-        },
-        {
-          text: 'Widgets',
-          collapsible: true,
-          items: [
-            { text: 'Classic Widgets', link: '/comfortaccounting/classic-widgets' },
-            { text: 'Elementor Widget', link: '/comfortaccounting/elementor-widgets' },
-            { text: 'Gutenberg Blocks', link: '/comfortaccounting/gutenberg-blocks' },
-          ],
-        },
         {
           text: 'User Guide',
           collapsible: true,
           items: [
             { text: 'General', link: '/comfortaccounting/user-guide/general' },
-            { text: 'Settings Manager', link: '/comfortaccounting/user-guide/settings-manager' },
+            { text: 'Dashboard', link: '/comfortaccounting/user-guide/dashboard' },
             { text: 'Agency Manager', link: '/comfortaccounting/user-guide/agency-manager' },
             { text: 'Account Manager', link: '/comfortaccounting/user-guide/account-manager' },
             { text: 'Category Manager', link: '/comfortaccounting/user-guide/category-manager' },
             { text: 'VC Manager', link: '/comfortaccounting/user-guide/vc-manager' },
             { text: 'Log Manager', link: '/comfortaccounting/user-guide/log-manager' },
             { text: 'Reports Manager (Pro)', link: '/comfortaccounting/user-guide/reports-manager' },
+            { text: 'Settings Manager', link: '/comfortaccounting/user-guide/settings-manager' },
             { text: 'Tools Manager', link: '/comfortaccounting/user-guide/tools-manager' },
+            { text: 'Emails Manager', link: '/comfortaccounting/user-guide/emails-manager' },
+            { text: 'Helps & Updates', link: '/comfortaccounting/user-guide/helps-updates' },
           ],
-        }
-      ],
-
-    
-      // Sidebar for `/guide/` section
-      '/comfortform/': [
+        },
+        {
+          text: 'Shortcode',
+          collapsible: true,
+          items: [
+            { text: '7 Shortcodes', link: '/comfortaccounting/shortcodes' },
+          ],
+        },
         {
-          text: 'Comfort Form',
+          text: 'Widgets',
           collapsible: true,
           items: [
-            { text: 'How to install', link: '/comfortform/how-to-install' },
-            { text: 'How to Translate', link: '/comfortform/how-to-translate' },
-            { text: 'Template Override', link: '/comfortform/template-override' },
-            { text: 'Shortcodes', link: '/comfortform/shortcodes' },
-            { text: 'Classic Widgets', link: '/comfortform/classic-widgets' },
-            { text: 'Elementor Widget', link: '/comfortform/elementor-widgets' },
-            { text: 'Gutenberg Blocks', link: '/comfortform/gutenberg-blocks' },
-            { text: 'Hooks and Filters', link: '/comfortform/hooks-and-filters' },
-            { text: 'Code Samples', link: '/comfortform/code-samples' },
+            { text: 'Classic Widgets', link: '/comfortaccounting/classic-widgets' },
+            { text: 'Elementor Widget', link: '/comfortaccounting/elementor-widgets' },
+            { text: 'Gutenberg Blocks', link: '/comfortaccounting/gutenberg-blocks' },
           ],
         },
       ],
+    
+      // Sidebar for `/guide/` section
+      // '/comfortform/': [
+      //   {
+      //     text: 'Comfort Form',
+      //     collapsible: true,
+      //     items: [
+      //       { text: 'How to install', link: '/comfortform/how-to-install' },
+      //       { text: 'How to Translate', link: '/comfortform/how-to-translate' },
+      //       { text: 'Template Override', link: '/comfortform/template-override' },
+      //       { text: 'Shortcodes', link: '/comfortform/shortcodes' },
+      //       { text: 'Classic Widgets', link: '/comfortform/classic-widgets' },
+      //       { text: 'Elementor Widget', link: '/comfortform/elementor-widgets' },
+      //       { text: 'Gutenberg Blocks', link: '/comfortform/gutenberg-blocks' },
+      //       { text: 'Hooks and Filters', link: '/comfortform/hooks-and-filters' },
+      //       { text: 'Code Samples', link: '/comfortform/code-samples' },
+      //     ],
+      //   },
+      // ],
+
      },
     // you can disable the previous and next page here
     docFooter: {
diff --git a/docs/comfortaccounting/shortcodes.md b/docs/comfortaccounting/shortcodes.md
@@ -12,55 +12,55 @@ card: "article"
 
 There are multiple shortcodes in frontend pro addon.
 
-## 1. Frontend Unified Accounting Dashboard \[comfortaccounting_accounting_dashboard\] Shortcode(Pro) ##
+## 1. Frontend Unified Accounting Dashboard \[comfortaccounting_accounting_dashboard\] Shortcode (Pro) ##
 
 **Where to use:** You can add this shortcode to manage all accounting components from frontend.
 
 Shortcode can be added in theme directly following this below code snippet
 
 https://gist.github.com/manchumahara/c4761d5c30f309694d0bd269b9fccaf9
 
-## 2. Frontend Agency Dashboard \[comfortaccounting_agency_dashboard\] Shortcode(Pro) ##
+## 2. Frontend Agency Dashboard \[comfortaccounting_agency_dashboard\] Shortcode (Pro) ##
 
 **Where to use:** You can add this shortcode to manage agency from frontend.
 
 Shortcode can be added in theme directly following this below code snippet
 
 https://gist.github.com/manchumahara/c4761d5c30f309694d0bd269b9fccaf9
 
-## 3. Frontend Agency Overview \[comfortaccounting_agency_overview\] Shortcode(Pro) ##
+## 3. Frontend Agency Overview \[comfortaccounting_agency_overview\] Shortcode (Pro) ##
 
 **Where to use:** You can add this shortcode to manage agency overview from frontend.
 
 Shortcode can be added in theme directly following this below code snippet
 
 https://gist.github.com/manchumahara/c4761d5c30f309694d0bd269b9fccaf9
 
-## 4. Frontend Account Dashboard \[comfortaccounting_account_dashboard\] Shortcode(Pro) ##
+## 4. Frontend Account Dashboard \[comfortaccounting_account_dashboard\] Shortcode (Pro) ##
 
 **Where to use:** You can add this shortcode to manage account from frontend.
 
 Shortcode can be added in theme directly following this below code snippet
 
 https://gist.github.com/manchumahara/c4761d5c30f309694d0bd269b9fccaf9
 
-## 5. Frontend Category Dashboard \[comfortaccounting_category_dashboard\] Shortcode(Pro) ##
+## 5. Frontend Category Dashboard \[comfortaccounting_category_dashboard\] Shortcode (Pro) ##
 
 **Where to use:** You can add this shortcode to manage category from frontend.
 
 Shortcode can be added in theme directly following this below code snippet
 
 https://gist.github.com/manchumahara/c4761d5c30f309694d0bd269b9fccaf9
 
-## 6. Frontend VC Dashboard \[comfortaccounting_vc_dashboard\] Shortcode(Pro) ##
+## 6. Frontend VC Dashboard \[comfortaccounting_vc_dashboard\] Shortcode (Pro) ##
 
 **Where to use:** You can add this shortcode to manage vendor client from frontend.
 
 Shortcode can be added in theme directly following this below code snippet
 
 https://gist.github.com/manchumahara/c4761d5c30f309694d0bd269b9fccaf9
 
-## 7. Frontend Log Dashboard \[comfortaccounting_log_dashboard\] Shortcode(Pro) ##
+## 7. Frontend Log Dashboard \[comfortaccounting_log_dashboard\] Shortcode (Pro) ##
 
 **Where to use:** You can add this shortcode to manage log from frontend.
 
diff --git a/docs/comfortaccounting/user-guide/category-manager.md b/docs/comfortaccounting/user-guide/category-manager.md
@@ -12,6 +12,19 @@ card: "article"
 
 # Comfort Accounting User Guide
 
-Welcome to the Comfort Accounting Category Manager.
+The Category Manager is designed to streamline the management of financial categories within the system, enabling clear organization and classification of transactions.
 
+## Key Features ##
 
+**Category Types**:
++ Categories can be classified as either **Income or Expense** types, allowing users to segregate financial data effectively.
+
+**Category Management**:
++ Users can easily **create, update, and manage categories** to suit their operational requirements.
++ The intuitive interface ensures hassle-free navigation and control over category data.
+
+**Category Color**:
++ Each category can be assigned a unique color, making it **visually distinguishable** and **easy to identify**.
++ The system enforces the **uniqueness** of category colors, ensuring no two categories share the same color.
+
+This component plays a vital role in organizing financial records, supporting a structured and efficient workflow for income and expense tracking.
diff --git a/docs/comfortaccounting/user-guide/general.md b/docs/comfortaccounting/user-guide/general.md
@@ -12,7 +12,7 @@ card: "article"
 
 # Comfort Accounting User Guide
 
-The Comfort Accounting plugin is a robust tool designed to streamline accounting processes in WordPress. It offers comprehensive features and settings to manage agencies, accounts, categories, vendors/clients, logs, reports, and integration with WooCommerce. Below is a brief overview of its core functionalities and configurable options:
+The Comfort Accounting plugin is a robust tool designed to streamline accounting processes in WordPress. It offers comprehensive features and settings to **manage agencies, accounts, categories, vendors/clients, logs, reports, and integration with WooCommerce**. Below is a brief overview of its core functionalities and configurable options:
 
 ## General Features ##
 + **Dashboard:** Global Dashboard that shows all the key information in one place.
@@ -58,4 +58,5 @@ Both export features are accessible only with the Reports Pro Addon, unlocking p
 [Category Manager](./category-manager.md)\
 [Vendor/Client Manager](./vc-manager.md)\
 [Log Manager](./log-manager.md)\
-[Report Manager (Pro)](./reports-manager.md)
+[Report Manager (Pro)](./reports-manager.md)\
+[Tools Manager](./tools-manager.md)
diff --git a/docs/comfortaccounting/user-guide/log-manager.md b/docs/comfortaccounting/user-guide/log-manager.md
@@ -12,6 +12,27 @@ card: "article"
 
 # Comfort Accounting User Guide
 
-Welcome to the Comfort Accounting Log Manager.
+The Log Manager is designed to capture and record financial data generated from accounts, categories, and the vendor/client (VC) manager. It consolidates various data points into a log entry, allowing for efficient tracking and reporting of financial transactions.
+
+## Key Features ##
+
+**Log Creation**:
++ Logs are created selecting values provided in the Account, Category, and Vendor/Client components. These values are combined to generate a complete log entry, representing a financial transaction.
+
+**Amount and Source Amount**:
++ Each log can include an Amount and a Source Amount, helping to track the primary transaction value and the originating amount for reference.
+
+**Currency**:
++ The Currency field allows users to specify the currency in which the transaction was conducted, providing flexibility for international operations. By default it will be the default currency set from settings.
+
+**Tax Values**:
++ Users can optionally add Tax Values to a log entry. A checkbox is provided to enable or disable tax inclusion, ensuring that tax management is flexible and aligned with business needs.
+
+**Attachments**:
++ The Log Component supports multiple attachments for each log entry. Users can upload relevant files in a separate tab dedicated to the attachment process.
++ Uploaded attachments are downloadable, allowing users to access and manage supporting documents related to each log entry.
+
+This component enhances the ability to track and manage financial transactions by offering flexible options for log creation, tax handling, and file attachments. It is a key feature for businesses seeking comprehensive log management.
+
 
 
diff --git a/docs/comfortaccounting/user-guide/settings-manager.md b/docs/comfortaccounting/user-guide/settings-manager.md
@@ -23,9 +23,11 @@ Navigate to **Comfort Accounting > Settings** in the WordPress admin dashboard.
 ## Basic Settings ##
 These fundamental settings allow you to define core parameters for your accounting system. Some key options:
 
-**Default Country:** Set the default country for all over the plugin.\
-**Default Currency:** Set the default currency for transactions.\
-**Number Settings**: Here we have option Number of Decimals, Decimal Separator, Thousand Separator, Currency Position.
++ **Default Country:** Set the default country for all over the plugin.
+
++ **Default Currency:** Set the default currency for transactions.
+
++ **Number Settings**: Here we have option Number of Decimals, Decimal Separator, Thousand Separator, Currency Position.
 
 Other options like **Show login form for guest user**, **Guest User Login Form**, **Show Register link to guest**, **Allow Edit Protected Logs**, **On Uninstall delete plugin data** are self introductory. Labels are there to guide.
 
@@ -35,25 +37,32 @@ Select the page where you have placed the shortcodes.
 ## File Attachments ##
 The File Upload/Attachments Settings section allows users to manage file attachments within the Comfort Accounting plugin, particularly for the Log component. These settings ensure that file uploads are handled securely and efficiently, aligning with your operational requirements.
 
-**Enable File Attachments:** Dropdown to enable disable file attachment feature for log component.\
-**Allowed File Types:** Dropdown or multi-select field to specify permitted file types (e.g., PDF, JPG, PNG)\
-**Max File Size (MB):** A numeric field where users can define the maximum allowable file size for uploads, measured in megabytes (MB).
++ **Enable File Attachments:** Dropdown to enable disable file attachment feature for log component.
+
++ **Allowed File Types:** Dropdown or multi-select field to specify permitted file types (e.g., PDF, JPG, PNG)
+
++ **Max File Size (MB):** A numeric field where users can define the maximum allowable file size for uploads, measured in megabytes (MB).
 
 ## Component Settings ##
 The Component Settings section in the Comfort Accounting plugin offers comprehensive customization options for managing each component key feature. These settings are designed to provide users with full control over the behavior and **configuration of individual components**, ensuring the plugin meets diverse accounting requirements.
 
-**[PRO]**\
-For pro addon **Comfort Accounting Reports** will add two option **Report Settings** & **Export Settings**\
-For pro addom **Comfort Accounting Woo** will add option **Woocommerce**
+**[PRO]**
++ For pro addon **Comfort Accounting Reports** will add two option **Report Settings** & **Export Settings**
+
++ For pro addon **Comfort Accounting Woo** will add option **Woocommerce**
 
 ## Woocommerce ##
 The WooCommerce Integration Settings section is designed to manage the seamless synchronization between WooCommerce and Comfort Accounting. With configurable options, you can tailor the integration to align with your specific operational needs.
 
-**Enable/Disable WooCommerce Integration:** Checkbox to activate or deactivate the WooCommerce integration.\
-**Agency Selection:** Input field to set an agency. This option is mandatory to associate WooCommerce transactions with a specific agency in the system.\
-**Associate Bank Account:** Checkbox to enable or disable the association of WooCommerce transactions with a specific bank account.\
-**Bank Account Selection:** Input field to set the bank account for associating WooCommerce transactions.\
-**Insert New Customer as Client:** Checkbox to automatically add new WooCommerce customers as clients in the Vendors/Clients area.\
++ **Enable/Disable WooCommerce Integration:** Checkbox to activate or deactivate the WooCommerce integration.
+
++ **Agency Selection:** Input field to set an agency. This option is mandatory to associate WooCommerce transactions with a specific agency in the system.
+
++ **Associate Bank Account:** Checkbox to enable or disable the association of WooCommerce transactions with a specific bank account.
+
++ **Bank Account Selection:** Input field to set the bank account for associating WooCommerce transactions.
+
++ **Insert New Customer as Client:** Checkbox to automatically add new WooCommerce customers as clients in the Vendors/Clients area.
 
 ## Saving Changes ##
 After adjusting these settings, click the Save Changes button to activate your preferences.
diff --git a/docs/comfortaccounting/user-guide/vc-manager.md b/docs/comfortaccounting/user-guide/vc-manager.md
@@ -12,6 +12,26 @@ card: "article"
 
 # Comfort Accounting User Guide
 
-Welcome to the Comfort Accounting Vendor Client (VC) Manager.
+The Vendor/Client (VC) Manager is designed to manage and organize vendors and clients within the system. This component provides an easy way to maintain crucial information related to each vendor or client, enhancing operational efficiency and data accuracy.
+
+## Key Features ##
+
+**Vendor/Client Types**:
++ Each record is categorized as either a Vendor or Client, helping to clearly **distinguish between the two types of entities**.
+
+**Address Information**:
++ This component includes fields to manage **detailed address** information for each vendor or client, ensuring all location-related data is captured accurately.
+
+**Official Contact Information**:
++ Users can maintain essential official contact information, including **phone numbers, email address**, and other relevant communication details.
+
+**Connected User**:
++ A Connected User option allows users to **link a specific user to a vendor or client**, helping to identify who is responsible for managing each vendor or client relationship within the system.
+
+**Export Options**:
++ Listing Export allows all agency details in bulk with supported formats, including **XLS, XLSX, ODS, and PDF**.
++ Single Export allow individual agency details in **JSON or PDF** format.
+
+This component plays a crucial role in managing the relationships and details of vendors and clients, streamlining workflows, and ensuring comprehensive data tracking for business operations.
 
 
