Copy updates intro to part 2 recap #2178
Conversation
✅ Deploy Preview for ember-guides ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Lovely, thanks! But: tutorial changes are managed in a separate repo (https://github.com/ember-learn/super-rentals-tutorial/blob/master/src/markdown/tutorial/part-1/04-component-basics.md) Would you be able to open a PR there? As otherwise they will get overwritten in this repo later. (cfr first line in each file) |
mansona
left a comment
mansona
left a comment
There was a problem hiding this comment.
generally I'm in favour of changes like this 👍 I left some comments on the quick-start and I stopped reviewing when I noticed you were PRing the output artefacts of the tutorial. Let me know if you need any help moving these suggestions to the tutorial generator 👍
|
|
||
| This code example uses a feature of JavaScript called classes. | ||
| Learn more with this [overview of the latest JavaScript features](https://ponyfoo.com/articles/es6). | ||
| Learn more with this [overview of the latest JavaScript features](https://web.dev/series/baseline-newly-available). |
There was a problem hiding this comment.
If we want to point to web.dev shouldn't we point to classes directly https://web.dev/learn/javascript/classes because we're talking about using classes
You would think that we don't need to give people a primer on classes in 2026 but because most other ecosystems don't use them it's probably still good to keep 🙈
| We'll need to make some changes to the code we wrote before. | ||
|
|
||
| In the rest of the code examples in this tutorial, whenever we add or remove code, we will show a "diff." The lines you need to remove have a minus sign in front of them, and the lines you should add have a plus sign. If you are using a screen reader while you go through the Guides, we recommend using Firefox and NVDA or Safari and VoiceOver for the best experience. | ||
| In the rest of the code examples in this tutorial, whenever we add or remove code, we will show a "diff." The lines you need to remove will be highlighted in red, and the lines you should add will be highlighted in green. If you are using a screen reader while you go through the Guides, we recommend using Firefox and NVDA or Safari and VoiceOver for the best experience. |
There was a problem hiding this comment.
considering we talk about accessibility in this paragraph maybe we shouldn't remove the "colourblind friendly" description here? we could say "highlighted in red with a minus sign in front of them" or something?
|
|
||
| ```gjs { data-filename="app/templates/index.gjs" data-diff="-1,+2,+3,-6,-7,+8,-12,+13" } | ||
| import { LinkTo } from '@ember/routing'; | ||
| ```gjs { data-filename="app/templates/index.gjs" data-diff="+2,-5,-6,+7,-11,+12" } |
There was a problem hiding this comment.
so the changes to the tutorial shouldn't be in a PR to the guides, it needs to go to the tutorial generator repo: https://github.com/ember-learn/super-rentals-tutorial
We're currently in the process of trying to get it working for the upcoming 6.10 release so if you want some help to get onboarded onto the tutorial generator let me know and I can help you land these 👍
4 participants
This pull request updates several tutorial and guide files to improve clarity, accessibility, and keep content up to date with external changes. The most significant changes include updating terminology and links related to Twitter (now X), improving instructions and descriptions for accessibility, and fixing minor grammatical and formatting issues.
Terminology and External References Updates
Accessibility and Instruction Improvements
Formatting and Grammar Fixes
Code and Component Naming Consistency
Rentals::FiltertoRentalsFilterand usinggjsinstead ofjsorhandlebars. [1] [2] [3] [4] [5]These changes collectively improve the accuracy, clarity, and accessibility of the guides and tutorials.