nus-cs2103-AY2021S2 / pe-dev-response

0 stars 0 forks source link

UG: Defining own theme not clear enough #2093

Open nus-pe-bot opened 3 years ago

nus-pe-bot commented 3 years 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.


When providing the sample monokai theme, the colours under "colors" are not explained. So which colour is applied to which UI element? With unclear usage, users are not inclined to try the feature. image.png


[original: nus-cs2103-AY2021S2/pe-interim#2093] [original labels: severity.Low type.DocumentationBug]

ivantjh commented 3 years ago

Team's Response

Thank you for your feedback. The team has reviewed this report and decided that this is an issue. However we'd like to change its severity from Medium to Low.

Referencing issue #27

Reason

The target audience of this feature has sufficient knowledge.

Elaboration

As mentioned in the user guide, "FriendDex allows advanced users to customize and apply their own themes". This feature is targeted at advanced users. theme command works fine with the predefined themes and customization is optional.

Particularly, it should say what EACH of the 16 hex codes in the color array points to

We feel that this is not feasible since there is too many UI components that exists in the application, and as the application grows, it is not viable to keep up with this changes.

If not, it would be a lot of trial and error when a user attempts to set his/her own theme

A user can simply look at the current theme file and compare it with what they see on the screen. theme allows on-the-fly changing of theme so figuring this out is pretty simple. The user guide also include ways to obtain more sample themes if they are still confused about this feature.

Dropping severity

Assuming this is a valid bug, then it wouldn't affect normal use of the user guide as this section caters to advanced users.

Duplicate status (if any):

Duplicate of #27