Skip to content
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

Add FAQ questions and answers #271

Conversation

belligerentbeagle
Copy link

@belligerentbeagle belligerentbeagle commented Apr 9, 2024

PLEASE FEEL FREE TO ADD ON AFTERWARDS

  1. Transferring data to and from another computer
  2. Launching TAPro in different ways
  3. Checking Java Version
  4. Using TAPro
  5. Saving more time with advanced features

PDF here:
TAPro - User Guide.pdf

Snippet of some of the changes:
Screenshot 2024-04-09 at 9 50 21 PM

Closes #269

1. Transferring data to and from another computer
1. Launching TAPro in different ways
1. Checking Java Version
1. Using TAPro
1. Saving more time with advanced features
@belligerentbeagle belligerentbeagle added chore docs Improvements or additions to documentation priority.medium !! size.small Short pr, less than 100 lines of code changed labels Apr 9, 2024
@belligerentbeagle belligerentbeagle added this to the v1.4 milestone Apr 9, 2024
@belligerentbeagle belligerentbeagle self-assigned this Apr 9, 2024
@belligerentbeagle belligerentbeagle added the type.ug User guide label Apr 9, 2024
Copy link
Member

@tituschewxj tituschewxj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for updating the FAQ! I have a few nits, mostly about the formatting.

The two main points I have are:

  • Use light boxes instead of seamless boxes.
  • Use question boxes to surround each QnA: <box type="info" icon=":fa-solid-question:" light>

docs/UserGuide.md Show resolved Hide resolved
docs/UserGuide.md Outdated Show resolved Hide resolved
docs/UserGuide.md Outdated Show resolved Hide resolved
docs/UserGuide.md Show resolved Hide resolved
docs/UserGuide.md Outdated Show resolved Hide resolved
docs/UserGuide.md Outdated Show resolved Hide resolved
docs/UserGuide.md Outdated Show resolved Hide resolved
docs/UserGuide.md Show resolved Hide resolved
docs/UserGuide.md Outdated Show resolved Hide resolved
docs/UserGuide.md Outdated Show resolved Hide resolved
Copy link

@wxiaoyun wxiaoyun left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Massive thanks for improving UG! FAQ certainly makes the UG more informative and welcoming. Just some formating nitpicks from me

docs/UserGuide.md Outdated Show resolved Hide resolved
docs/UserGuide.md Outdated Show resolved Hide resolved
docs/UserGuide.md Show resolved Hide resolved

<span class="semi-bold">#g#Example:##</span> Unmarking a wrongly marked student's attendance

1. `mark nn/e0123456 wk/6`

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Technically mark nn/e0123456 wk/6 works, but note that since all NUSNETs are capitalized internally, typing nn/e and press tab will not autocomplete (since there is no suggestions). So yes, we should use nn/E so that during pe, they cant complain about it

docs/UserGuide.md Outdated Show resolved Hide resolved
belligerentbeagle and others added 7 commits April 10, 2024 13:57
…into 269-improve-faq-section-anyone-feel-free-to-add

* 'master' of https://github.com/AY2324S2-CS2103T-F13-1/tp:
  Allow keyFormat to support icon
  Fix example of addstu that used `add` instead of `addstu`
  Fix typo
  Add page break
  Fix autocomplete docs

# Conflicts:
#	docs/UserGuide.md
Co-authored-by: Wu Xiaoyun <w.xy020203@gmail.com>
…ps://github.com/belligerentbeagle/tp into 269-improve-faq-section-anyone-feel-free-to-add

* '269-improve-faq-section-anyone-feel-free-to-add' of https://github.com/belligerentbeagle/tp:
  Update docs/UserGuide.md
Co-authored-by: Wu Xiaoyun <w.xy020203@gmail.com>
…ps://github.com/belligerentbeagle/tp into 269-improve-faq-section-anyone-feel-free-to-add

* '269-improve-faq-section-anyone-feel-free-to-add' of https://github.com/belligerentbeagle/tp:
  Update docs/UserGuide.md

# Conflicts:
#	docs/UserGuide.md
docs/UserGuide.md Outdated Show resolved Hide resolved
Copy link

@wxiaoyun wxiaoyun left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Massive thanks

Comment on lines +622 to +625
Replace "<abosute_path_to_TAPro.jar>" with the path to TAPro on your system, in quotes.<br>
Example on Windows: `java -jar "C:\Users\YOUR_USERNAME\Downloads\TAPro.jar"`<br>
Example on Linux: `java -jar /home/YOUR_USERNAME/Downloads/TAPro.jar`<br>
Example on macOS: `java -jar "/Users/YOUR_USERNAME/Downloads/TAPro.jar"`<br>

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Replace "<abosute_path_to_TAPro.jar>" with the path to TAPro on your system, in quotes.<br>
Example on Windows: `java -jar "C:\Users\YOUR_USERNAME\Downloads\TAPro.jar"`<br>
Example on Linux: `java -jar /home/YOUR_USERNAME/Downloads/TAPro.jar`<br>
Example on macOS: `java -jar "/Users/YOUR_USERNAME/Downloads/TAPro.jar"`<br>
Replace "<abosute_path_to_TAPro.jar>" with the path to TAPro on your system, in quotes.<br>
Example on Windows: `java -jar "C:\Users\YOUR_USERNAME\Downloads\TAPro.jar"`<br>
Example on Linux: `java -jar /home/YOUR_USERNAME/Downloads/TAPro.jar`<br>
Example on macOS: `java -jar "/Users/YOUR_USERNAME/Downloads/TAPro.jar"`<br>

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just double confirming, we need the quotes for macOS scripts?

Example on macOS: `java -jar "/Users/YOUR_USERNAME/Downloads/TAPro.jar"`<br>
                             ^                                        ^

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It works with or without. However if there happen to be spaces in any part of the path, it wouldn't work without quotes. so safer with quotes.

Copy link
Member

@tituschewxj tituschewxj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@tituschewxj tituschewxj merged commit ec2c63d into AY2324S2-CS2103T-F13-1:master Apr 10, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chore docs Improvements or additions to documentation priority.medium !! size.small Short pr, less than 100 lines of code changed type.ug User guide
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve FAQ section (Anyone feel free to add)
3 participants