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

docs(cli): add command descriptions #6991

Merged
merged 1 commit into from
Feb 18, 2022
Merged

Conversation

bluwy
Copy link
Member

@bluwy bluwy commented Feb 18, 2022

Description

Closes #6940

Add descriptions to CLI commands

Additional context

With vite --help:

Before:

Commands:
  [root]           
  build [root]     
  optimize [root]  
  preview [root]  

After:

Commands:
  [root]           start dev server
  build [root]     build for production
  optimize [root]  pre-bundle dependencies
  preview [root]   locally preview production build

What is the purpose of this pull request?

  • Bug fix
  • New Feature
  • Documentation update
  • Other

Before submitting the PR, please make sure you do the following

  • Read the Contributing Guidelines.
  • Read the Pull Request Guidelines and follow the Commit Convention.
  • Check that there isn't already a PR that solves the problem the same way to avoid creating a duplicate.
  • Provide a description in this PR that addresses what the PR is solving, or reference the issue that it solves (e.g. fixes #123).
  • Ideally, include relevant tests that fail without this PR but pass with it.

@bluwy bluwy added the p1-chore Doesn't change code behavior (priority) label Feb 18, 2022
@patak-dev patak-dev merged commit ffda8f0 into vitejs:main Feb 18, 2022
@bluwy bluwy deleted the cli-description branch February 18, 2022 18:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
p1-chore Doesn't change code behavior (priority)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Docs] Add more description to vite --help
3 participants