Closed papataco14 closed 11 months ago
8: Weird motto
Before:
Master Your Internship Journey: Every Deadline, Every Detail.
Suggestion:
Your one-stop internship application tracker
10: Remove irrelevant portions of intro Before:
It's that time of the year again! You're scrolling through LinkedIn to discover internship opportunities and tackling programming problems non-stop to prepare for your coding interviews, all in pursuit of securing a summer internship. To increase your chances, you've mass-applied to multiple companies, and now you're struggling to keep track of all your applications.
Suggestion:
It's that time of the year again! You're scrolling through LinkedIn to discover internship opportunities, in hopes of trying to secure one for summer. To increase your chances, you've mass-applied to multiple companies, and now you're struggling to keep track of all your applications.
14: Line doesn't match what is listed. What exactly about those are related to a journey?
Before:
Here is a quick overview of your internship journey with LinkMeIn:
Suggestion:
Here's a quick overview of how LinkMeIn transforms your internship application process:
22: Tailored sounds weird.
Before:
Moreover, LinkMeIn combines the rapid efficiency of Command Line Interface (CLI) with the visual clarity of Graphical User Interface (GUI), providing a tailored experience just for you.
Suggestion:
LinkMeIn combines the speed and efficiency of the Command Line Interface (CLI) with the visual clarity of the Graphical User Interface (GUI), offering a best-of-both-worlds experience.
28: Rename the header for better accuracy and fit rubric Before:
Navigating the User Guide
Suggestion:
How to use this guide
53,56,57: Explanation doens't fit for all scenarios where that style is used Before:
Represents content that you can type into the command box.
Represents the acceptable parameters that you can key into a command.
Suggestion:
Used to highlight specific elements such as file names, commands, or any text that should be viewed as code or a distinct element within the text.
Used to describe information about the parameters that you can key into a command.
54-55: Hyperlink still doesn't work. It brings me to the top of the pdf
87,89: Grammar. Change in your computer
to on your computer
Before:
In this section, you will learn how to set up LinkMeIn in your computer.
Suggestion:
In this section, you will learn how to set up LinkMeIn "on" your computer.
96: Image too big
Suggestion: Cut to smaller image
99: Before: Sounds weird
- Move the downloaded jar file into a home folder of your choice, such as the Desktop or Documents folder for your LinkMeIn.
Suggestion:
- Move the downloaded jar file into a home folder of your choice, such as the Desktop or Documents folder.
for your LinkMeIn.
106: Phrasing Before:
Enter the next command
Suggestion:
Type the command
113: Before: What is applications referring to ?
* Do not move or delete the `data` folder as it contains the data of your applications.
Suggestion:
* Do not move or delete the `data` folder as it contains the data of your internship applications.
121: Hyperlink for GUI section unnecessary
Line 167: Is there a way to put the shorten the parameter to fit one line?
Line 170-171: Why is this italicised?
185: Grammar Before:
The
add
command word is used to initiate the adding a company into LinkMeIn.
Suggestion:
The
add
command word is used to initiate the adding "of" a company into LinkMeIn.
190: The table below is not introduced well Before:
But wait! Notice the
[]
aroundpr/PRIORITY
?
Suggestion:
But wait! Notice the
[]
aroundpr/PRIORITY
? Here's what it means:
194: Change C/COMPANY_NAME
to c/COMPANY_NAME
for consistency
199: Example: change to Examples
205: Readability problem, might miss the comma.
Before:
- Parameters can be in any order. e.g. If the command specifies c/COMPANY_NAME r/ROLE, r/ROLE c/COMPANY_NAME is also acceptable.
Suggestion:
- Parameters can be in any order. e.g. If the command specifies
c/COMPANY_NAME r/ROLE
,r/ROLE c/COMPANY_NAME
is also acceptable.
206: Might want to include that prefixes are case-insensitive too
Before:
- Parameters are case-insensitive. e.g. c/COMPANY_NAME is the same as c/company_name.
Suggestion:
- Parameters and prefixes are case-insensitive. e.g. c/COMPANY_NAME is the same as C/company_name.
209: Remove hyperlink to quick tour section
229: Before:
Now, follow us along this tour and transform yourself into a master of your internship application!
Suggestion:
Now, follow us along this tour and transform yourself into a master of "tracking" your internship application!
263: Grammar Before:
Now that you had added your first few companies into LinkMeIn, you may want to view the details of a specific company.
Suggestion:
Now that you "have" added your first few companies into LinkMeIn, you may want to view the details of a specific company.
314: Remove the hyperlink to the Features section as it is right below
: Before:
Suggestion:
line 640: Phrasing abit weird
Before:
You've applied to many companies, and now you want to track internship applications for a particular company. Use the
find
command to quickly locate the company you want!
Suggestion:
You've applied to many companies, and now you wish to monitor your internship applications for a specific company. Use the
find
command for a swift and efficient way to locate the company you want!
line 650: are we keeping to case-insensitive?
The case of the keyword doesn't matter (e.g.
tiktok
will matchTikTok
).
line 654: Should be the tip box instead of the note box and header should be "Useful Tip:"
line 687: Weird phrasing
Before:
Whenever LinkMeIn is started, you will see the full list of companies displayed by default (i.e.
list
command is executed automatically).
Suggestion:
Upon launching LinkMeIn, you will see your full list of companies. (i.e.
list
command is executed automatically).
line 699: after we hyperlink to application param desc, should we also have a hyperlink at line 814 to hyperlink back to filter command, I think that will improve the navigability.
line 703: improve phrasing
Before:
You want to prepare for the upcoming interviews you have received.
After:
You wish to prepare for the upcoming interviews that you have secured
line 709: improve phrasing
before:
You can then view all the companies that you have pending interviews for from the Company List Panel.
after:
You can then check the Company List Panel for all the companies where you have pending interviews.
line 736: wrong box should be the tip box
line 779 - 780: Parameter and prefix already defined in a table in introducing LinkmeIn CLI, do we want to define it again in glossary?
Can consider adding more FAQs:
LinkMeIn is an offline application that functions well without an internet connection. However, an Internet connection is required to download the application.
With LinkMeIn, there is no need for you to save manually. Everything is saved automatically for you.
Fixed in #298, #299, #301, #305
Format
Line(s): Problem Before:
Suggestion:
Or anything that makes sense. Link
One person, one comment. Edit your comments.