User guide instructions could be clearer.

[nus-pe-bot]

Under the quick start section it is showed that

so the command specified to open the GOATS application is written as java -jar GOATS.jar

However, because of the naming of the jar file. the command doesn't work. I had to use java -jar CS2103T-T09-4-GOATS.jar instead. While i understand that this is an issue regarding the file name. i think it might be better to specify it as java -jar [file name].jar instead since i actually tried java -jar GOATS.jar and it didn't work.

---

_{[original: nus-cs2103-AY2425S1/pe-interim#2515] [original labels: severity.Medium type.DocumentationBug]}

[elliot-tang]

Team's Response

Thank you for your feedback regarding the command for launching the GOATS application as detailed in our Quick Start guide.

We acknowledge the confusion caused by the .jar file name specified in the command. GOATS.jar is the naming convention followed on the releases page of our application. The project submission was the only exception that required a different naming format for the jar file that included the Team Name. Therefore, if the PE did not require a specific naming format, the name of the application would be consistent with the UG, as evidenced by our previous releases.

The bug should be triaged as severity.low as it arises from the naming of the .jar file, which causes minor inconvenience since users need to manually replace GOATS.jar with the actual file name when running the command. It does not affect the functionality of the product itself or its core operations. Users can still successfully launch the application by making a small adjustment to the command. It is not severe enough to disrupt normal operations or usability significantly, making severity.Low the appropriate categorization.

Thank you for supporting GOATS.

Regards, Development Team

Duplicate status (if any):

--