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 #111
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
The feature list have a whole chunk of feature and command, this will be quite hard for the user to identify and search for what they need. Let's re-organize the flow of the feature and give them a category for it.
There is not much description for the `clear` command. Let's add a visual representation of what the user should expect after entering the command
The explanation was in a point form, this may not be easy to read for the users. Let's update the explanation and put into a table form and: - update the content to make it more relatable
The explanation was in a point form, this may not be easy to read for the users. Let's update the explanation and put into a table form
The explanation was in a point form, this may not be easy to read for the users. Let's update the explanation and put into a table form
There is no distinct different between a module command and a requirement command Let's give them some colors to differentiate between each other Note: The color will only be displayed in the `html` version
lycjackie
added
status.Ongoing
|
Closing this in view of #207 |
lycjackie
added
status.Rejected
# 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: