You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/UserGuide.md
+38-86Lines changed: 38 additions & 86 deletions
Original file line number
Diff line number
Diff line change
@@ -62,116 +62,68 @@ Jobby comes equipped with a [GUI]() interface that provides visual feedback to y
62
62
Hello and welcoem to Jobby! We are delighted that you've chosen our platform to manage your internship application process!
63
63
64
64
Before we begin, please ensure that you have viewed the following sections of the guide:
65
-
*[Quick Start]() to help you get Jobby up and running
66
-
*[Navigating the Interface]() to get you familiarised with navigating Jobby
65
+
*[Installation](#installation) to help you get Jobby up and running.
66
+
*[Navigating the Interface](#navigating-the-interface) to get you familiarised with navigating Jobby.
67
67
68
68
This tutorial aims to guide you through the most essential features and functionalities of Jobby that you will use on a day-to-day
69
69
basis. In this guide, you will learn how to add your first tutor and corresponding schedule!
70
70
71
71
Click on any of the hyperlinks below to jump to respective sections of the tutorial!
72
-
* Beginning
73
-
* Adding your first contact
74
-
* Adding your first application
72
+
*[The Beginning](#beginning)
73
+
*[Adding your first Organization](#adding-your-first-organization)
74
+
*[Adding your first Recruiter](#adding-your-first-recruiter)
75
+
*[Adding your first Application](#adding-your-first-application)
75
76
76
-
Jobby comes equipped with a [GUI]() interface that provides visual feedback to you. Below is a quick overview of the various components of our interface.
77
-
78
-

79
-
80
-
### Adding `Contact`
81
-
Jobby can create `Contacts`. In the form of `Organization` and `Recruiter`, which you can add into your database with simple CLI commands.
82
-
83
-
Let's say you want to track your job application for the `Organization: Woogle`, with a `Recruiter: John`.
84
-
85
-
You can add the `Organization` into Jobby with a simple command:
You have successfully added **Josh Mao**, who is a **recruiter** from Google, whose number is **91219121**.
168
111
112
+
### Adding your first Application
169
113
114
+
After preparing your resume, you are ready to apply to **Google** as an intern for their **Software Engineer** role! And you know that the application deadline is on the **2-11-2023**.
170
115
171
-

116
+
In order to track your application, you can use [apply](#applying-to-organizations---apply) to track your application:
117
+
1. type `apply google_id --title Software Engineer --by 22-11-2023` into the command box
You managed to add your application to **Google**! With the role you are interested in, **Software Engineer** and the application deadline which is **22-11-2023**.
174
123
124
+
**Congratulations!** You have ran through the basics of Jobby. We hope that this tutorial has gave you an understanding of the
125
+
basic workflow of Jobby. However, there are still many features that we have yet introduced. Please refer to the [Using Jobby Section](#using-jobby) to understand
126
+
the command structure of Jobby, or visit [Features Section](#features) to see the full capabilities of Jobby!
0 commit comments