This repository has been archived by the owner on May 20, 2023. It is now read-only.
docs/UserGuide: improve structure of the user guide #207
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
lycjackie
added
status.Ongoing
lycjackie
force-pushed
the
ug-update-flow
branch
13 times, most recently
from
29502fe to
1545eec
Compare
lycjackie
added
status.ToReview
lycjackie
force-pushed
the
ug-update-flow
branch
from
1545eec to
b7c20bf
Compare
Creastery
suggested changes
Apr 13, 2019
Creastery
added
status.Ongoing
lycjackie
force-pushed
the
ug-update-flow
branch
5 times, most recently
from
a5d7bca to
22fa184
Compare
lycjackie
force-pushed
the
ug-update-flow
branch
3 times, most recently
from
28f06cf to
b684172
Compare
lycjackie
added
status.ToReview
lycjackie
force-pushed
the
ug-update-flow
branch
6 times, most recently
from
0839fb0 to
ec04b0b
Compare
Our user guide although have some sort of flow, it is not sufficient for our reader to navigate our user guide efficiently. In additional, we did not provide clear notation to allow our reader to understand our GUI easily. General command such as `clear` do not provide the user with clear illustration on what is the expectation of the command. Let's update the `UserGuide` to support the flow and: * add a label GUI * change to smaller font for `Figure X` images * clean up the FAQ * add images to illustrate for clear command.
lycjackie
force-pushed
the
ug-update-flow
branch
from
ec04b0b to
c4c0d04
Compare
Creastery
approved these changes
Apr 13, 2019
# for free
to subscribe to this conversation on GitHub.
Already have an account?
#.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The feature list has a whole chunk of feature and command,
this will be quite hard for the user to identify and search for
what they need.
We should organize our feature properly for our users to be
able to use our user guide efficiently.
Let's rearrange our features and categories them according
to its purpose and: