curriculum
curriculum copied to clipboard
Using Flexbox or Grid Lesson - Update Grammar, Simplify Wording, Improve Explanations
Complete the following REQUIRED checkboxes:
- [x] I have thoroughly read and understand The Odin Project Contributing Guide
- [x] The title of this issue follows the
location for request: brief description of request
format, e.g.NodeJS course: Add lessons on XYZ
The following checkbox is OPTIONAL:
- [x] I would like to be assigned this issue to work on it
1. Description of the Feature Request:
This lesson has clear issues with wording and is difficult to read. Here are some examples:
these are complementary tools that can work together
Complementary implies two things works well together, no need for the further explanation.
If starting with the content, and working from the smallest parts outwards, then a developer is using Content-First Design. This is a great opportunity to use Flexbox because of the flexibility it provides in manipulating code in one dimension - along either rows or columns.
I think content-first design is not explained thoroughly nor clearly. I think it's important to explain what starting with the content
actually means. I think it would be much more accurate to say that content-first design is based around the content as it is often used to create layouts that are fluid without strict positioning locations. Comparing this with Grid (which is used to create more rigid designs) would clearly outline the different goals and use cases of flexbox and grid.
If, however, a developer is given a specific overall layout to adhere to and needs explicit placement of elements in two dimensions, using both rows and columns, then Grid would be much better suited.
I think this comes off as confusing as it has two comma splices which create a complicated sentence. Split this into multiple sentences would make it more clear.
Additionally, the lesson often uses the phrase "the developer". I think this would be better stated as "a developer".
2. Acceptance Criteria:
- [ ] Remove the "that can work together" from the introduction
- [ ] Clearly explain content-first design
- [ ] Change "the developer" to "a developer"
3. Additional Information:
There may be other grammatical and word choice errors that make this lesson difficult to read that I missed. I'd love if someone could take a look at this lesson and let me know any other wording errors they find.
Hello 👋
I like the suggestions above. Please create a pull request with all the changes you'd like to see for the lesson. Thanks, @ArjunSaili1
This issue is stale because it has had no activity for the last 30 days.
Hello 👋
I like the suggestions above. Please create a pull request with all the changes you'd like to see for the lesson. Thanks, @ArjunSaili1
No activity from OP in quite a while, putting this back in for help wanted.
Closing this issue for now.. while the issues the original poster brought up are valid, they aren't so bad that the lesson can't be understood. Suggestions like this are probably better received as PRs to the appropriate lesson instead of a request for someone else to do the work.