Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/.vuepress/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ module.exports = {

],
sidebar: {
'/2.0/': require('./version-configs/2.0')
'/': require('./version-configs/index.js')
}
},
markdown: {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,15 +1,14 @@
/* set version */
let version = '2.0';

/* version prefix setter */
function setVersionPrefix(children) {
if (children.constructor === Array) {
return children.map(child => {
child[0] = `/${version}/${child[0]}`;
child[0] = `/${child[0]}`;
return child;
});
}
return `/${version}/${children}`;
return `/${children}`;
}

/* module export */
Expand Down
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ home: true
heroText: Krayin User Documentation
tagline: A Comprehensive User Guide to Seamlessly Navigate Krayin.
actionText: Get Started →
actionLink: /2.0/introduction/
actionLink: /introduction/

features:
- title: Leads and Pipeline
Expand Down
12 changes: 6 additions & 6 deletions docs/2.0/activity/activities.md → docs/activity/activities.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,34 +28,34 @@ Go to the admin panel click on **Leads >> Open Lead >> Click on Activity** and a

Now click on the **Save Activity** button

![Create Activity](../../assets/2.0/images/activity/createActivity.png)
![Create Activity](../../docs/assets/images/activity/createActivity.png)

Now it will be visible where activity is created in the **All** & **Lunch, Call, Meeting** sections accordingly as shown in the below image.

![Activity](../../assets/2.0/images/activity/activity.png)
![Activity](../../docs/assets/images/activity/activity.png)

Now the created Activity becomes visible in the activity grid as shown in the image below.

![Create Activity](../../assets/2.0/images/activity/activityGrid.png)
![Create Activity](../../docs/assets/images/activity/activityGrid.png)

### Calendar View

After the creation of the activity, you can see it in the Activities tab directly. You can also find out your desired activity when you click Calendar view according to the created date and time.

![Activity Grid](../../assets/2.0/images/activity/calender.png)
![Activity Grid](../../docs/assets/images/activity/calender.png)

### Edit or Delete the Activity

By using the Actions tab you can edit or delete the activity as shown in the image.

![Activity Grid](../../assets/2.0/images/activity/editActivity.png)
![Activity Grid](../../docs/assets/images/activity/editActivity.png)

### Use of Filter

Here you can use the Filter tab to find out the desired activity.

By default, there are **Title, Created By, Lead, Schedule From, Schedule To, Created At** filters available as shown in the image below.

![Activity Grid](../../assets/2.0/images/activity/filter.png)
![Activity Grid](../../docs/assets/images/activity/filter.png)

By following the above steps you can easily create & manage activity in Krayin CRM.
File renamed without changes.
6 changes: 3 additions & 3 deletions docs/2.0/configure/general.md → docs/configure/general.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,11 @@ By default, we provide the following languages:
**English, Arabic, Spanish, Portuguese, Persian, Turkish, and Vietnamese**.
Now click on the **Save** button.

![Configure](../../assets/2.0/images/configure/general/locale.png)
![Configure](../../docs/assets/images/configure/general/locale.png)

**Step-3** As shown in the below image, once **Arabic** is selected, the layout updates automatically to match the Arabic language and orientation.

![Arabic](../../assets/2.0/images/configure/general//arabic.png)
![Arabic](../../docs/assets/images/configure/general//arabic.png)

By following the above steps, you can easily configure and use multiple locales in Krayin CRM.

Expand All @@ -28,7 +28,7 @@ The **Admin Logo** section allows you to upload a custom logo for the CRM admin

**Step-1** In the same **Settings >> Configuration >> General** page, scroll to the **Admin Logo** section as shown in the image below.

![Admin Logo](../../assets/2.0/images/configure/general//admin-logo.png)
![Admin Logo](../../docs/assets/images/configure/general//admin-logo.png)

**Step-2** Upload the following:

Expand Down
6 changes: 3 additions & 3 deletions docs/2.0/configure/imap.md → docs/configure/imap.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ The **IMAP Settings** section in Krayin CRM allows you to connect your email acc

- **Validate SSL Certificate** – Check this box to validate the server's SSL certificate.

![Server details](../../assets/2.0/images/configure/settings/imap-server.png)
![Server details](../../docs/assets/images/configure/settings/imap-server.png)

---

Expand All @@ -39,7 +39,7 @@ The **IMAP Settings** section in Krayin CRM allows you to connect your email acc

- **IMAP Password** – Your email account password (input is masked)

![Email password](../../assets/2.0/images/configure/settings/email-password.png)
![Email password](../../docs/assets/images/configure/settings/email-password.png)

---

Expand All @@ -48,7 +48,7 @@ The **IMAP Settings** section in Krayin CRM allows you to connect your email acc
**Step-4** Click on the **Save Configuration** button to store the settings.


![IMAP Save button](../../assets/2.0/images/configure/settings/imap-save-button.png)
![IMAP Save button](../../docs/assets/images/configure/settings/imap-save-button.png)

---

Expand Down
14 changes: 7 additions & 7 deletions docs/2.0/configure/magic.md → docs/configure/magic.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The **Magic AI** section in Krayin CRM enables you to connect an AI model using

**Step-2** Enable the **Magic AI** feature by switching the **Enable** toggle to ON.

![Status button](../../assets/2.0/images/configure/settings/status-button.png)
![Status button](../../docs/assets/images/configure/settings/status-button.png)

---

Expand All @@ -24,7 +24,7 @@ The **Magic AI** section in Krayin CRM enables you to connect an AI model using
**Step-3** In the **API Key** field, enter your API key generated from [OpenRouter](https://openrouter.ai).
Each AI model should use a unique key for better security and performance.

![Api key](../../assets/2.0/images/configure/settings/api-key.png)
![Api key](../../docs/assets/images/configure/settings/api-key.png)

🔗 [How to create an OpenRouter API key](https://krayincrm.com/how-to-use-magic-ai-in-krayin-crm/)

Expand All @@ -36,28 +36,28 @@ Each AI model should use a unique key for better security and performance.

- If a model is listed, select it from the dropdown.

![Modles](../../assets/2.0/images/configure/settings/modles.png)
![Modles](../../docs/assets/images/configure/settings/modles.png)

- If not, enter the model name manually in the **Other Model** field.
Example:

![Modles](../../assets/2.0/images/configure/settings/other-model.png)
![Modles](../../docs/assets/images/configure/settings/other-model.png)

---

## Enable DOC Generation

**Step-5** Enable the **DOC Generation** toggle to allow the system to extract text content from uploaded `.doc` files automatically.

![Doc Generation](../../assets/2.0/images/configure/settings/doc-generation.png)
![Doc Generation](../../docs/assets/images/configure/settings/doc-generation.png)

---

### Save Configuration

**Step-6** Click on the **Save Configuration** button to apply all changes.

![Save button](../../assets/2.0/images/configure/settings/save-button.png)
![Save button](../../docs/assets/images/configure/settings/save-button.png)

---
**Step-7** Go to **Leads >> All Leads**.
Expand All @@ -68,7 +68,7 @@ Each AI model should use a unique key for better security and performance.

- These leads will appear in the **“New” stage** by default on your leads pipeline board.

![Lead Stage](../../assets/2.0/images/configure/settings/leads-upload.png)
![Lead Stage](../../docs/assets/images/configure/settings/leads-upload.png)

You can then edit, assign, or move these leads through the pipeline as needed.

Expand Down
10 changes: 5 additions & 5 deletions docs/2.0/configure/settings.md → docs/configure/settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ The **Powered by** section allows you to customize or remove the footer text sho
**Step-2** Enter your desired footer text in the **Powered by text editor**.


![Powered By](../../assets/2.0/images/configure/settings/poweredby.png)
![Powered By](../../docs/assets/images/configure/settings/poweredby.png)

**Step-3** Click on the **Save Configuration** button to apply the changes.

Expand Down Expand Up @@ -52,10 +52,10 @@ The **Menu Item Configurations** section allows you to rename default sidebar me
- Configuration

**Step-3** Replace the text **Dashboard** with **Home** or any label of your choice.
![Menu Items](../../assets/2.0/images/configure/settings/menu-item.png)
![Menu Items](../../docs/assets/images/configure/settings/menu-item.png)

**Step-4** After updating the names, click on the **Save Configuration** button.
![Ater itemsupdate](../../assets/2.0/images/configure/settings/sidebar.png)
![Ater itemsupdate](../../docs/assets/images/configure/settings/sidebar.png)

By following the above steps, you can rename the sidebar items to better suit your business workflow.

Expand All @@ -70,11 +70,11 @@ The **Menu Item Color Configurations** section allows you to change the color sc

**Step-2** Choose a color using the **Brand Color** picker for the menu items.

![Menu Color](../../assets/2.0/images/configure/settings/brand-color.png)
![Menu Color](../../docs/assets/images/configure/settings/brand-color.png)

**Step-3** Click on the **Save Configuration** button to apply the selected color.

![After Save](../../assets/2.0/images/configure/settings/after-save-color.png)
![After Save](../../docs/assets/images/configure/settings/after-save-color.png)

By following the above steps, you can easily customize the sidebar menu colors in Krayin CRM to reflect your brand identity.

Expand Down
18 changes: 9 additions & 9 deletions docs/2.0/contact/contacts.md → docs/contact/contacts.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ This individual could be a customer, a lead, a prospect, or any other person wit

**Step-1** Go to admin panel of krayin and click on **Contacts >> Persons >> Create Person** as shown in the below image.

![Create Person](../../assets/2.0/images/contact/createPerson.png)
![Create Person](../../docs/assets/images/contact/createPerson.png)

**Step-2** Add the below details.

Expand All @@ -26,27 +26,27 @@ This individual could be a customer, a lead, a prospect, or any other person wit

**6) Organization-** Enter the name of the organization.

![Person](../../assets/2.0/images/contact/person.png)
![Person](../../docs/assets/images/contact/person.png)

Now click on **Save as Person** button.

**Step-3** Now a new record is created click on Persons to check the record in the contact person data grid.

![Person](../../assets/2.0/images/contact/personGrids.png)
![Person](../../docs/assets/images/contact/personGrids.png)

### Edit or Delete the Person

By using the Actions tab you can edit or delete the person as shown in the image.

![Person](../../assets/2.0/images/contact/action.png)
![Person](../../docs/assets/images/contact/action.png)

### Filters for Person

Here you can use the Filter tab to find out the desired person.

By default, there are **ID, Name, Emails, Contact Numbers, Organization Name** filters available as shown in the image below.

![Person](../../assets/2.0/images/contact/personFilter.png)
![Person](../../docs/assets/images/contact/personFilter.png)

## Orgnization

Expand All @@ -58,7 +58,7 @@ It could be a commercial enterprise, a non-profit organization, a government age

**Step-1** Go to admin panel of krayin and click on **Contacts >> Organizations >> Create Organization** as shown in the below image.

![Person](../../assets/2.0/images/contact/createOrganization.png)
![Person](../../docs/assets/images/contact/createOrganization.png)

**Step-2** Add the below details briefly.

Expand All @@ -70,19 +70,19 @@ It could be a commercial enterprise, a non-profit organization, a government age

Now click on **Save Organization** button.

![Person](../../assets/2.0/images/contact/organization.png)
![Person](../../docs/assets/images/contact/organization.png)

**Step-3** Now a new record is created in the contact organization data grid.

![Person](../../assets/2.0/images/contact/organizationGrid.png)
![Person](../../docs/assets/images/contact/organizationGrid.png)

### Filters for Organization

Here you can use the Filter tab to find out the desired organization.

By default, there are **ID, Name, Created At,** filters available as shown in the image below.

![Person](../../assets/2.0/images/contact/organizationFilter.png)
![Person](../../docs/assets/images/contact/organizationFilter.png)

**NOTE-** These above **Persons** and **Organization** you can assign it while creating a lead.

Expand Down
File renamed without changes.
20 changes: 10 additions & 10 deletions docs/2.0/lead/leads.md → docs/lead/leads.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ A **Lead** is a potential customer or prospect. Generating a lead is the first s
**Step-1** Go to the admin panel of Krayin and click on
**Leads >> Create Lead**.

![Lead create](../../assets/2.0/images/lead/createLead.png)
![Lead create](../../docs/assets/images/lead/createLead.png)

---

Expand All @@ -25,7 +25,7 @@ A **Lead** is a potential customer or prospect. Generating a lead is the first s
- **Sales Owner** – Assign a sales owner.
- **Expected Close Date** – Set an estimated closing date.

![Lead Details](../../assets/2.0/images/lead/leadDetails.png)
![Lead Details](../../docs/assets/images/lead/leadDetails.png)

---

Expand All @@ -36,7 +36,7 @@ A **Lead** is a potential customer or prospect. Generating a lead is the first s
- **Contact Number**
- **Organization**

![Contact details](../../assets/2.0/images/lead/contactDetails.png)
![Contact details](../../docs/assets/images/lead/contactDetails.png)

---

Expand All @@ -47,16 +47,16 @@ A **Lead** is a potential customer or prospect. Generating a lead is the first s
- Quantity
- Total Amount

![Product details](../../assets/2.0/images/lead/productDetilas.png)
![Product details](../../docs/assets/images/lead/productDetilas.png)

---

**Step-5** Click on **Save as Lead** to store the new lead.
![newLead](../../assets/2.0/images/lead/newleads.png)
![newLead](../../docs/assets/images/lead/newleads.png)

A complete pipeline is generated. You can move leads between stages or customize your sales stages.

![Pipline](../../assets/2.0/images/lead/pipeline.png)
![Pipline](../../docs/assets/images/lead/pipeline.png)

---

Expand All @@ -66,16 +66,16 @@ Krayin CRM also supports **document-based lead creation** using Magic AI.

**Step-6** Go to **Leads >> All Leads** and click on the **Upload File** button.

![Upload Lead button](../../assets/2.0/images/lead/uploadLeadButton.png)
![Upload Lead button](../../docs/assets/images/lead/uploadLeadButton.png)

**Step-7** Select a `.doc`, `.pdf`, or image file that contains lead-related data.
Once uploaded, Magic AI will automatically extract details (e.g., Name, Email, Phone, Organization) and create a new lead.

![Upload lead modal](../../assets/2.0/images/lead/uploadLeadModal.png)
![Upload lead modal](../../docs/assets/images/lead/uploadLeadModal.png)

The uploaded leads will appear in the **"New" stage** of the pipeline.

![Upload lead in new stage](../../assets/2.0/images/lead/newleads.png)
![Upload lead in new stage](../../docs/assets/images/lead/newleads.png)

> 🔗 *Note: This feature requires Magic AI and DOC Generation to be enabled in*
> **Settings >> Configuration >> Magic AI**
Expand All @@ -98,7 +98,7 @@ Available filters include:
- Expected Close Date
- Created At

![Lead Fillter](../../assets/2.0/images/lead/leadFillter.png)
![Lead Fillter](../../docs/assets/images/lead/leadFillter.png)

---

Expand Down
Loading