Updated Introduction by simplifying the writing #192
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ijlee2
commented
Jul 26, 2020
|
|
||
| The CLI comes with a command-line-based help system too. At any point, if you're curious what a command does and what the options are, you can add `--help` to the command and press enter to find out more. | ||
| For new users, the recommended learning path is to first do the Ember.js [Quickstart](https://guides.emberjs.com/release/getting-started/quick-start/) and [Tutorial](https://guides.emberjs.com/release/tutorial/). These teach the commands while building a sample app. Then, review the [Basic use](./basic-use) section of this site as a reference. |
There was a problem hiding this comment.
I added a link to the Basic use section.
ijlee2
commented
Jul 26, 2020
|
|
||
| The CLI comes with a help system too. At any point, if you're not sure what a command does and what its options are, you can add `--help` to the command and press enter to find out more. | ||
|
|
||
| ```shell |
There was a problem hiding this comment.
I added an example of using --help.
ijlee2
commented
Jul 26, 2020
ijlee2
commented
Jul 26, 2020
|
|
||
| ## Getting help | ||
|
|
||
| Do you have questions? Run into an issue or a bug? Get support from the community. A list of chat rooms, forums, and more are available [here](https://www.emberjs.com/community/). | ||
| Did you have questions? Run into an issue or a bug? Get support from the community. A list of chat rooms, forums, and more is available on the [Community](https://www.emberjs.com/community/) page. |
There was a problem hiding this comment.
I changed "are" to "is" and provided a descriptive information for the link ("here" is, in general, discouraged, I believe).
Co-authored-by: Robert Jackson <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
I was reviewing what we mention in the CLI Guides with regards to the folder structure for an in-repo addon. On the long horizon, I'd like to document the colocated folder structure in Octane (this pertains to the issue #135).
As I review each section, if it's okay with the team, I'd like to update the section by simplifying the writing (the grammar). For example, in this PR, I preferred 2 short sentences instead of 1 joined by an "and" or a "which." I'm hoping that the result is a writing that is easier to parse and feels conversational when read out aloud.