Skip to content

Commit

Permalink
Merge pull request #96 from TanZhanMing/Update-Help
Browse files Browse the repository at this point in the history
Update help documentation
  • Loading branch information
TanZhanMing authored Oct 8, 2019
2 parents 86cffbc + 429302b commit 6d4e7f7
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 3 deletions.
2 changes: 1 addition & 1 deletion docs/AboutUs.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ image::tanzhanming.png[width="150", align="left"]
{empty}[http://https://github.com/TanZhanMing[github]] [<<johndoe#, portfolio>>]

Role: Integration +
Responsibilities: Budget Feature
Responsibilities: Budget and Help Features


'''
21 changes: 19 additions & 2 deletions docs/UserGuide.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,23 @@ e.g. typing *`help`* and pressing kbd:[Enter] will open the help window.

=== Viewing help : `help`

Format: `help`
Provides 3 different types of help for all commands.

Keyword: `help`

Format:
`help cmd/COMMAND type/TYPE`

Refer to <<Command Summary>> for all available commands

Types include: brief (gives a brief description) +
guide (opens a web browser and bring you to our user guide) +
api (for advanced users who want to know the inner workings of the command)

Examples:
`help cmd/add_income type/brief` +
`help cmd/goto type/guide` +
`help cmd/help type/api`

=== Changing Views : `goto`

Expand Down Expand Up @@ -301,7 +317,8 @@ Automatically detects command and comes up with suggestions as a pop-up on what

== Command Summary

* *Help* : `help`
* *Help* : `help cmd/COMMAND type/TYPE` +
e.g. `help cmd/add_claim type/bief`

* *Changing of Views* `goto (parameter)`
e.g. `goto claims`
Expand Down

0 comments on commit 6d4e7f7

Please sign in to comment.