Skip to content

Commit a52f47c

Browse files
committed
user guide settings manager and general added
1 parent 4a30ead commit a52f47c

File tree

4 files changed

+81
-1
lines changed

4 files changed

+81
-1
lines changed

.idea/php.xml

Lines changed: 3 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/.vitepress/config.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,7 @@ export default {
104104
collapsible: true,
105105
items: [
106106
{ text: 'General', link: '/comfortaccounting/user-guide/general' },
107+
{ text: 'Settings Manager', link: '/comfortaccounting/user-guide/settings-manager' },
107108
{ text: 'Agency Manager', link: '/comfortaccounting/user-guide/agency-manager' },
108109
{ text: 'Account Manager', link: '/comfortaccounting/user-guide/account-manager' },
109110
{ text: 'Category Manager', link: '/comfortaccounting/user-guide/category-manager' },

docs/comfortaccounting/user-guide/general.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,19 @@ card: "article"
1212

1313
# Comfort Accounting User Guide
1414

15-
Welcome to the Comfort Accounting User Guide.
15+
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:
1616

17+
## General Features ##
18+
**Dashboard:** Global Dashboard that shows all the key information in one place.\
19+
**Component Management:** Customize the behavior of key components such as Agency, Account, Category, Vendor/Client, Log, and Reports**[Pro]**.\
20+
**Settings Manager**: Configure Basic Settings, Email Settings, File Upload/Attachments Settings & Components Settings. Also, we have WooCommerce Integration Settings in this place.\
1721

22+
## Components we have: ##
23+
Agency Manager.
24+
Account Manager.
25+
Category Manager.
26+
Vendor/Client Manager.
27+
Log Manager.
28+
Report Manager**[Pro]**.
29+
30+
This summary provides a high-level view of the plugin's capabilities. For detailed guidance, explore the corresponding sections linked above.
Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
---
2+
title: "Comfort Accounting Documentation"
3+
description: "Comfort Accounting index description."
4+
keywords: "Comfort Accounting index keywords."
5+
url: "/comfortaccounting/"
6+
type: "type"
7+
site_name: "Comfort ERP"
8+
image: "https://comforthrm.com/assets/images/seo.png"
9+
card: "article"
10+
11+
---
12+
13+
# Comfort Accounting User Guide
14+
15+
This short guide provides a basic walkthrough for setting up the Comfort Accounting plugin. For detailed instructions on each component, refer to the specific sections in the plugin documentation.
16+
17+
# General Settings Overview #
18+
The Comfort Accounting plugin is designed with a modular and intuitive settings structure, ensuring that users can easily configure and tailor the plugin to their specific needs. Below is an overview of the key configuration areas:
19+
20+
# Accessing the Settings Panel #
21+
Navigate to **Comfort Accounting > Settings** in the WordPress admin dashboard. This section is organized into various sections, each dedicated to specific configuration options.
22+
23+
## Basic Settings ##
24+
These fundamental settings allow you to define core parameters for your accounting system. Some key options:
25+
26+
**Default Country:** Set the default country for all over the plugin.\
27+
**Default Currency:** Set the default currency for transactions.\
28+
**Number Settings**: Here we have option Number of Decimals, Decimal Separator, Thousand Separator, Currency Position.
29+
30+
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.
31+
32+
## Pages ##
33+
Select the page where you have placed the shortcodes.
34+
35+
## File Attachments ##
36+
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.
37+
38+
**Enable File Attachments:** Dropdown to enable disable file attachment feature for log component.\
39+
**Allowed File Types:** Dropdown or multi-select field to specify permitted file types (e.g., PDF, JPG, PNG)\
40+
**Max File Size (MB):** A numeric field where users can define the maximum allowable file size for uploads, measured in megabytes (MB).
41+
42+
## Component Settings ##
43+
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.
44+
45+
**[PRO]**\
46+
For pro addon **Comfort Accounting Reports** will add two option **Report Settings** & **Export Settings**\
47+
For pro addom **Comfort Accounting Woo** will add option **Woocommerce**
48+
49+
## Woocommerce ##
50+
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.
51+
52+
**Enable/Disable WooCommerce Integration:** Checkbox to activate or deactivate the WooCommerce integration.\
53+
**Agency Selection:** Input field to set an agency. This option is mandatory to associate WooCommerce transactions with a specific agency in the system.\
54+
**Associate Bank Account:** Checkbox to enable or disable the association of WooCommerce transactions with a specific bank account.\
55+
**Bank Account Selection:** Input field to set the bank account for associating WooCommerce transactions.\
56+
**Insert New Customer as Client:** Checkbox to automatically add new WooCommerce customers as clients in the Vendors/Clients area.\
57+
58+
## Saving Changes ##
59+
After adjusting these settings, click the Save Changes button to activate your preferences.
60+
61+
This configuration provides flexibility while maintaining control over file uploads, ensuring an optimal balance between functionality and security.
62+
63+

0 commit comments

Comments
 (0)