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

Update examples for CLI Commands in UG #2247

Merged
merged 2 commits into from
Mar 30, 2023
Merged

Conversation

lhw-1
Copy link
Contributor

@lhw-1 lhw-1 commented Mar 29, 2023

What is the purpose of this pull request?

  • Documentation update
  • Bug fix
  • Feature addition or enhancement
  • Code maintenance
  • DevOps
  • Improve developer experience
  • Others, please explain:

Overview of changes:

Fills in missing explanations for some of the examples in the CLI Commands section of the User Guide, and standardizes the explanations for the rest where needed.

An example of missing explanations for examples is the serve Command section of this page.

Anything you'd like to highlight/discuss:

Testing instructions:

Proposed commit message: (wrap lines at 72 characters)

Update examples for CLI Commands in UG


Checklist: ☑️

  • Updated the documentation for feature additions and enhancements
  • Added tests for bug fixes or features
  • Linked all related issues
  • No unrelated changes

@lhw-1 lhw-1 requested a review from a team March 29, 2023 11:51
Copy link
Contributor

@itsyme itsyme left a comment

Choose a reason for hiding this comment

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

Thanks @lhw-1! These changes make the examples clearer for users to understand :) Just some minor nits!

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

@itsyme itsyme left a comment

Choose a reason for hiding this comment

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

LGTM! Great job @lhw-1!

@lhw-1 lhw-1 added this to the v4.1.1 milestone Mar 30, 2023
@lhw-1 lhw-1 merged commit c5263ba into MarkBind:master Mar 30, 2023
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.

None yet

2 participants