Please check if your PR fulfills the following requirements:
[x] Docs have been reviewed and added / updated if needed (for bug fixes / features)
[ ] Build (npm run build) was run locally and any changes were pushed
[ ] Tests (npm test) were run locally and passed
[ ] Prettier (npm run prettier) was run locally and passed
Pull request type
Please check the type of change your PR introduces:
- [ ] Bugfix
- [ ] Feature
- [ ] Refactoring (no functional changes, no api changes)
- [ ] Build related changes
- [x] Documentation content changes
- [ ] Other (please describe):
## What is the current behavior?
The documentation in the CLI leaves a little bit to be desired
GitHub Issue Number: N/A
What is the new behavior?
this commit update the usage of the cli to provide additional
information around:
command vs interactive modes
flags that can be used when calling the cli
setting environment variables
it also splits the contribution section out into its own guide, stealing
some of its contents from the stencil core repo
Pull request checklist
Please check if your PR fulfills the following requirements:
npm run build) was run locally and any changes were pushednpm test) were run locally and passednpm run prettier) was run locally and passedPull request type
Please check the type of change your PR introduces: - [ ] Bugfix - [ ] Feature - [ ] Refactoring (no functional changes, no api changes) - [ ] Build related changes - [x] Documentation content changes - [ ] Other (please describe): ## What is the current behavior?The documentation in the CLI leaves a little bit to be desired
GitHub Issue Number: N/A
What is the new behavior?
this commit update the usage of the cli to provide additional information around:
it also splits the contribution section out into its own guide, stealing some of its contents from the stencil core repo
Does this introduce a breaking change?
Testing
N/A
Other information