-
Notifications
You must be signed in to change notification settings - Fork 6
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update ug introduction #129
Update ug introduction #129
Conversation
…into update-ug-introduction
… into update-ug-introduction
…into update-ug-introduction � Conflicts: � docs/UserGuide.md
…into update-ug-introduction
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great work, and thanks for helping to proof read and edit across the entire doc as well! Just a minor nit apart from which we'll be good to merge!
docs/UserGuide.md
Outdated
Company | com | company name, industry, job title | A company offering internships | ||
Internship | int | company name, job title, industry, requirements, period, wage, status | An internship offered by a company |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I believe these attributes for Company and Internship are the outdated ones?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the spot, will update it.
|
||
|
||
### Company | ||
|
||
Note: You must be on the **Companies** page in order to execute these commands. | ||
Note: You must be on the **Company** tab in order to execute these commands. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I see we've changed the tab name from plural to singular. I was wondering if it would be odd since the user would be looking at a tab labelled "Company" but in it can be multiple companies? Likewise for "Application" as well, which to me sounds like I'll view a single application if I click on it. Small matter but perhaps we could discuss this further and see what the team thinks too!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
True I am not sure about which is a more appropriate wording.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Alright, no worries! Will merge this first and we can settle this next time.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
Edited the ToC to match Command Summary
Edited the Introduction