Skip to content

Commit 94fffca

Browse files
committed
docs updated
1 parent 5ceeaf1 commit 94fffca

File tree

7 files changed

+29
-37
lines changed

7 files changed

+29
-37
lines changed

docs/comfortjob/user-guide/company-manager.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ card: "article"
1010

1111
---
1212

13-
### Managing Company
13+
### Managing Company (Pro plugin feature)
1414

1515
1. Go to `Comfort Job > Companies`.
1616
2. View, edit, or delete companies listings as needed.

docs/comfortjob/user-guide/emails.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,11 @@ The Comfort Job plugin includes an email system to notify users about various ev
2121

2222
#### Available Email Templates
2323

24-
- **New Job Application**: `guest_job_create_to_user.php`(Pro)
25-
- **Job Approved**: `guest_job_email_verified.php`(Pro)
24+
- **Job Published Email For User**: `job_published_to_user.php`
25+
- **New job create admin alert**: `guest_job_create_to_admin.php`
26+
- **New Job create User alert**: `guest_job_create_to_user.php`(Pro)
27+
- **Job Approved Admin alert**: `guest_job_verify_to_admin.php`(Pro)
28+
- **Job Approved User alert**: `guest_job_email_verified.php`(Pro)
2629

2730
### Single Email Settings
2831

docs/comfortresume/code-samples.md

Lines changed: 10 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,14 @@ use Comfort\Resume\Helpers\ComfortResumeHelpers;
1919
// Add a new resume
2020
$resume_data = [
2121
'name' => 'John Doe',
22+
'slug' => 'f5fu705f5d',
2223
'email' => 'john.doe@example.com',
2324
'privacy' => 'public',
24-
'sections' => [
25+
'status' => 'published',
26+
'owner' => 2, // User ID,
27+
'is_primary' => 0,
28+
'add_date' => gmdate( 'Y-m-d H:i:s' )
29+
'sections' => json_encode([
2530
'aboutme' => [
2631
'given_name' => 'John',
2732
'family_name' => 'Doe',
@@ -37,9 +42,9 @@ $resume_data = [
3742
'description' => 'Developed web applications.',
3843
],
3944
],
40-
],
45+
]),
4146
];
42-
$new_resume = ComfortResumeHelpers::addResume($resume_data);
47+
$new_resume = Resume::create($resume_data);
4348
```
4449

4550
## Fetch Resume Data
@@ -92,28 +97,13 @@ $pdf_html = ComfortResumeProHelpers::displayResumePdfHtml($resume_id, $resume_da
9297
file_put_contents('resume_' . $resume_id . '.pdf', $pdf_html);
9398
```
9499

95-
## Add Custom Sections to a Resume
96-
97-
```php
98-
use Comfort\ResumePro\Helpers\ComfortResumeProHelpers;
99-
100-
// Add a custom section to a resume
101-
$custom_section = [
102-
'title' => 'Custom Section',
103-
'content' => 'This is a custom section.',
104-
];
105-
ComfortResumeProHelpers::addCustomSection($resume_id, $custom_section);
106-
```
107-
108-
## Bookmark a Resume
100+
## Delete a Bookmark
109101

110102
```php
111103
use Comfort\ResumePro\Models\CBXBookmark;
112104

113-
// Bookmark a resume for a user
114-
$user_id = get_current_user_id();
115105
$resume_id = 123;
116-
$result = CBXBookmark::bookmarkResume($user_id, $resume_id);
106+
$result = CBXBookmark::find( $id )->delete();
117107
```
118108

119109
---

docs/comfortresume/hooks-and-filters.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -27,18 +27,17 @@ card: "article"
2727
} );
2828
```
2929

30-
2. **`comfortresume_resume_section_display`**
31-
- Triggered when a resume section is displayed.
30+
2. **`comfortresume_resume_created`**
31+
- Triggered when a resume is created.
3232
- **Parameters**:
33-
- `$resume_id` (int): The ID of the resume.
34-
- `$type` (string): The type of the section.
35-
- `$section_data` (array): Data of the section.
36-
- `$resume_data` (array): Data of the resume.
33+
- `$resume` (object): The resume object.
34+
- `$queryParams` (array): Request query params received in api.
35+
- `$source` (string): From where the api is called(frontent/backend).
3736
- **Example**:
3837
```php
39-
add_action( 'comfortresume_resume_section_display', function( $resume_id, $type, $section_data, $resume_data ) {
38+
add_action( 'comfortresume_resume_created', function( $resume, $queryParams, $source ) {
4039
// Custom logic for displaying a resume section
41-
}, 10, 4 );
40+
}, 10, 3 );
4241
```
4342

4443
3. **`comfortresume_before_vuejs_mount_after`**

docs/comfortresume/user-guide/general.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ class ComfortResume {
7272
### ComfortResumeAdmin
7373
Handles the admin functionalities of the plugin, located in `ComfortResumeAdmin.php`.
7474

75-
```
75+
```php
7676
<?php
7777
class ComfortResumeAdmin {
7878
public function create_menus() {
@@ -87,7 +87,7 @@ class ComfortResumeAdmin {
8787
### ComfortResumePublic
8888
Handles the public-facing functionalities of the plugin, located in `ComfortResumePublic.php`.
8989

90-
```
90+
```php
9191
<?php
9292
class ComfortResumePublic {
9393
public function enqueue_scripts() {
@@ -98,7 +98,7 @@ class ComfortResumePublic {
9898
### ComfortResumeShortcode
9999
Handles the public-facing functionalities of the plugin, located in `ComfortResumeShortcode.php`.
100100

101-
```
101+
```php
102102
<?php
103103
class ComfortResumeShortcode {
104104
public function init_shortcode() {
@@ -147,7 +147,7 @@ To display the resume dashboard, use the following shortcode:
147147

148148
The uninstallation script is located in ComfortResumeUninstall.php.
149149

150-
```
150+
```php
151151
<?php
152152
ComfortResumeUninstall::uninstall();
153153
```

docs/comfortresume/user-guide/resume-category.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ card: "article"
1313
### Resume Categories
1414

1515
1. Go to `Comfort Resume > Categories`.
16-
2. Add new resume categories by filling in the name and description.
16+
2. Add new resume categories by filling in the name field.
1717
3. Save changes.
1818

1919

docs/comfortresume/user-guide/resume-tags.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ card: "article"
1313
### Resume Tags
1414

1515
1. Go to `Comfort Resume > Resume Tags`.
16-
2. Add new resume tags by filling in the name and description.
16+
2. Add new resume tags by filling in the name field.
1717
3. Save changes.
1818

1919

0 commit comments

Comments
 (0)