Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add help usage to user guide #996

Merged
merged 1 commit into from
Feb 6, 2020
Merged

Add help usage to user guide #996

merged 1 commit into from
Feb 6, 2020

Conversation

madanalogy
Copy link
Contributor

What is the purpose of this pull request? (put "X" next to an item, remove the rest)

• [X] Documentation update

What is the rationale for this request?

Resolves #862

What changes did you make? (Give an overview)

  1. Changed alias of --version to capitalised letter -V
  2. Addition of PageNav menu to cliCommands
  3. Verbose elaboration of --help usage with examples

Is there anything you'd like reviewers to focus on?

Addition of PageNav menu (whether it was done correctly). I tried reading the developer guide but I'm still not sure how to go about previewing my changes. Do I simply call markbind serve from the /docs directory? Any advice would be appreciated :)

Proposed commit message: (wrap lines at 72 characters)

Add help usage to user guide

docs/userGuide/cliCommands.md Outdated Show resolved Hide resolved
docs/userGuide/cliCommands.md Outdated Show resolved Hide resolved
@madanalogy madanalogy requested a review from acjh February 1, 2020 09:04
Copy link
Contributor

@acjh acjh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your changes. We can improve this documentation further.

docs/userGuide/cliCommands.md Outdated Show resolved Hide resolved
docs/userGuide/cliCommands.md Outdated Show resolved Hide resolved
docs/userGuide/cliCommands.md Outdated Show resolved Hide resolved
@madanalogy
Copy link
Contributor Author

Note: I rearranged the order of commands on the page to be consistent with the order in the help output of the summary section

@madanalogy madanalogy requested a review from acjh February 3, 2020 06:14
docs/userGuide/cliCommands.md Outdated Show resolved Hide resolved
docs/userGuide/cliCommands.md Show resolved Hide resolved
docs/userGuide/cliCommands.md Outdated Show resolved Hide resolved
docs/userGuide/cliCommands.md Outdated Show resolved Hide resolved
@madanalogy madanalogy requested a review from acjh February 4, 2020 06:33
@yamgent yamgent added this to the v2.10.0 milestone Feb 6, 2020
@yamgent yamgent merged commit 6b44e3c into MarkBind:master Feb 6, 2020
@madanalogy madanalogy deleted the 862-add-help-doc branch February 6, 2020 08:25
nbriannl pushed a commit to nbriannl/markbind that referenced this pull request Feb 9, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add --help to documentation on CLI
4 participants