search

AY2122S2-CS2103T-T09-3 / tp

MIT License
0 stars 4 forks source link

[PE-D] Documentation of JSON format in user guide #246

Closed nus-pe-script closed 2 years ago

nus-pe-script commented 2 years ago

Screenshot 2022-04-01 at 3.59.03 PM.png

As your target user may not be tech savvy, they may not be able to understand what to do if json format is incorrect. Maybe can let them know what to do in case this occurs? Such as providing documentation on what the JSON format should be like so they can edit it accordingly

Labels: severity.Low type.DocumentationBug original: DannyDakota/ped#10

arcornior commented 2 years ago

I agree with adding in documentation on how the JSON format should be like, allowing users to fix any corrupted JSON files. This would likely take up a huge chunk of space in the UG, as I'll have to add in information on valid/invalid parameters for the different JSON fields. Good point!

arcornior commented 2 years ago

After much consideration, we have decided that users should not have to modify trackermon.json. More effort will be placed into ensuring that the files are stored correctly so users do not have to worry about invalid formats.