Clarify "why Resources", add more examples, and what *not* using resources is like. #361
Conversation
NullVoxPopuli
force-pushed
the
readme-updates
branch
3 times, most recently
from
5a99a1b
to
d123c76
Compare
| {{this.records}} | ||
| ``` | ||
|
|
||
| In this example, `trackedFunction` will make a call to [StarWars API](https://swapi.dev/) |
There was a problem hiding this comment.
Maybe it will be better than putting it into words, paste a code there? Or maybe both?
@action
switchToPlanets() {
this.endpoint = 'planets';
}
| > | ||
| > Ember templates are declarative. When we design a component, like the profile component from our previous example, we are specifying declaratively the HTML that should be rendered. If the data used in the templates ever updates, then Ember will update the rendered output as well, and we don't have to worry about the details. We don't have to tell Ember which specific steps to take, and when - it figures everything out for us. | ||
|
|
||
| <div style="width: 100%; text-align: right;"> |
There was a problem hiding this comment.
It is tiny bit weird how this is rendered without margins around. The next paragraph then sticks to it.
There was a problem hiding this comment.
Would this format be better for citing?
README.md
Outdated
| For example, if you wanted to lazily and reactively load data based on | ||
| an `@argument` passed to a component | ||
|
|
||
| <details><summary>In vanilla Ember, no addons</summary> |
There was a problem hiding this comment.
I like the collapsibles, but it's just hard to notice when scanning the rendered document. I wonder if having sub-sub-section header right above each of them would help? Just a thought, feel free to ignore.
There was a problem hiding this comment.
imo, there is too much in this README to not have collapsibles for secondary information. Imagine in the following examples there were also 200+ lines of code
There was a problem hiding this comment.
I love the collapsibles. I just wanted pointed out that while scanning the document, they are easy to miss. Ultimately an issue with how browsers / github decided to style those.
There was a problem hiding this comment.
Yeah. I'm gonna try to figure out how to make this it's own page, so the examples aren't needed
This line assumes a lot of detailed knowledge about the topic. Maybe it is a good idea to add a section later in the README that can hand hold the reader through this decision making caveat and link to it where the note is? |
Yeah 🤔 I think maybe it makes sense to just remove that section? |
Deploying with
|
| Latest commit: |
7dbdae8
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://5cd26c96.ember-resources.pages.dev |
Co-authored-by: Jonny Green <[email protected]>
NullVoxPopuli
force-pushed
the
readme-updates
branch
from
6692b1d
to
0a8c247
Compare
|
🎉 This PR is included in version 4.3.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
Rendered