Explain divisions between guides #36
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
locks
requested changes
May 1, 2020
guides.md
Outdated
|
|
||
| In some cases, a feature may be omitted from the Guides until it has reached some level of improvements to tooling or coherence with a mental model, but this is decided on a case-by-case basis. | ||
|
|
||
| ## The Ember CLI Guides |
There was a problem hiding this comment.
Suggested change
| ## The Ember CLI Guides | |
| ### The Ember CLI Guides |
|
|
||
| The Ember Guides are meant to cover the needs of the majority of Ember users. They focus on runtime features, but may have some build time information. If 80% of people who run `ember new` would need the information, it should be covered in the Guides. Deprecated features should not be shown in the latest version. The Guides are not meant to be exhaustive of Ember's features, but rather they read like a book and give you the "happy path" journey through building an app. In contrast, the API Docs are meant to cover all of Ember's features. | ||
|
|
||
| In some cases, a feature may be omitted from the Guides until it has reached some level of improvements to tooling or coherence with a mental model, but this is decided on a case-by-case basis. |
There was a problem hiding this comment.
We might want to create an issue to update this once the Stages RFC comes through and we have the "Recommended" stage.
guides.md
Outdated
|
|
||
| ## The Ember Guides | ||
|
|
||
| The Ember Guides are meant to cover the needs of the majority of Ember users. They focus on runtime features, but may have some build time information. If 80% of people who run `ember new` would need the information, it should be covered in the Guides. Deprecated features should not be shown in the latest version. The Guides are not meant to be exhaustive of Ember's features, but rather they read like a book and give you the "happy path" journey through building an app. In contrast, the API Docs are meant to cover all of Ember's features. |
There was a problem hiding this comment.
Suggested change
| The Ember Guides are meant to cover the needs of the majority of Ember users. They focus on runtime features, but may have some build time information. If 80% of people who run `ember new` would need the information, it should be covered in the Guides. Deprecated features should not be shown in the latest version. The Guides are not meant to be exhaustive of Ember's features, but rather they read like a book and give you the "happy path" journey through building an app. In contrast, the API Docs are meant to cover all of Ember's features. | |
| The Ember Guides are meant to cover the needs of the majority of Ember users. They focus on runtime features, but may have some build time information. If 80% of people who run `ember new` would need the information, it should be covered in the Guides. | |
| Deprecated features should not be shown in the latest version. | |
| The Guides are not meant to be exhaustive of Ember's features, but rather they read like a book and give you the "happy path" journey through building an app. In contrast, the API Docs are meant to cover all of Ember's features. |
Giving the paragraphs some breathing room so that at a glance you noticed "Deprecated" and "API Docs".
mansona
approved these changes
May 5, 2020
locks
approved these changes
May 21, 2020
|
This looks like it's ready to merge? And so ember-learn/cli-guides#168 can be closed also? |
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.
This PR follows on work done to try and come up with a rule of thumb to separate CLI guides and Ember guides. It records it for future reference. Here, "rule of thumb" means that these categorizations should usually work, but we can break them on an as-needed basis.