willowisp01 / pe

0 stars 0 forks source link

No diagrams for many features in UG (from page 13-19) #12

Open willowisp01 opened 4 months ago

willowisp01 commented 4 months ago

For the features in page 13-19, there are no diagrams at all, which may make it hard for new users to follow. For example, on page 18, sched is a command that takes in a lot of parameters. A before and after would help users to see what changes your command should make.

nus-pe-bot commented 4 months ago

Team's Response

Lots of screenshots are provided in the features section.

We did not wish to flood the new user tutorial with too many diagrams as that could be overwhelming instead.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: I think the issue is that in your examples used from page 13 - 19, the actions are based on a pre-existing setup in your app. That is to say, the app should have a certain state for your example to work as expected. Hence, I think it's reasonable that there is an image for how the the state should be before and after. It's not immediately apparent from your text instructions alone.