search

nus-cs2113-AY2223S1 / pe-dev-response

0 stars 0 forks source link

No mention of the need of internet connection in quick start #793

Open nus-pe-bot opened 1 year ago

nus-pe-bot commented 1 year ago

Note from the teaching team: This bug was reported during the Part II (Evaluating Documents) stage of the PE. You may reject this bug if it is not related to the quality of documentation.

As I was testing the program, I notice that it uses APIs and requires internet connection. However, it is not mentioned in quick start, and I could only know when I read up to Appendix.

image.png

[original: nus-cs2113-AY2223S1/pe-interim#830] [original labels: type.DocumentationBug severity.Medium]

cheehengk commented 1 year ago

Team's Response

The dev team believes that the quick start section of the UG could be improved by indicating that Internet connection is required. However, it does not severely affect usability and furthermore, this requirement can be understood within the UG itself as per the tester's bug report.

Duplicate status (if any):

--