New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
fix(curriculum): inconsistencies for code examples in cat photo app #54526
fix(curriculum): inconsistencies for code examples in cat photo app #54526
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm going to challenge this and say new concepts do not all need an example. New syntax does.
The more text we add, the less likely campers are to read any of it. If we're showing an example for every new element or attribute, we're also removing the "think about how you add an attribute" process after we've already taught them how to add an attribute.
...-responsive-web-design-22/learn-html-by-building-a-cat-photo-app/5dc23f9bf86c76b9248c6eba.md
Outdated
Show resolved
Hide resolved
...-responsive-web-design-22/learn-html-by-building-a-cat-photo-app/5dc2385ff86c76b9248c6eb7.md
Show resolved
Hide resolved
...-responsive-web-design-22/learn-html-by-building-a-cat-photo-app/5dc23991f86c76b9248c6eb8.md
Show resolved
Hide resolved
...-responsive-web-design-22/learn-html-by-building-a-cat-photo-app/5dfa2407b521be39a3de7be1.md
Show resolved
Hide resolved
...-responsive-web-design-22/learn-html-by-building-a-cat-photo-app/5dc174fcf86c76b9248c6eb2.md
Show resolved
Hide resolved
...-responsive-web-design-22/learn-html-by-building-a-cat-photo-app/5ef9b03c81a63668521804df.md
Show resolved
Hide resolved
...-responsive-web-design-22/learn-html-by-building-a-cat-photo-app/5ef9b03c81a63668521804e5.md
Show resolved
Hide resolved
...-responsive-web-design-22/learn-html-by-building-a-cat-photo-app/5efc4f528d6a74d05e68af74.md
Show resolved
Hide resolved
...-responsive-web-design-22/learn-html-by-building-a-cat-photo-app/5f07be6ef7412fbad0c5626b.md
Show resolved
Hide resolved
Honestly, looking at some of these steps, the tests are so ancient that they're still using jQuery. Before shoving more examples into the steps, I think I'd rather see the tests + hint text updated to better guide the campers in a granular way. |
I pushed an update to remove some of the code examples. We could remove the remaining code examples steps where I left comments and see if updating the hint text and tests will work instead |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we can go with this, I'll circle back next week and overhaul the tests.
Looks Good To Me! 👍 |
Summary of changes
As I was helping campers on the forum, I noticed there were inconcentices and when we show code examples for new concepts and when we don't.
For example in step 8, we explan what a
src
attribute is and provide an examplehttps://www.freecodecamp.org/learn/2022/responsive-web-design/learn-html-by-building-a-cat-photo-app/step-8
But then in other places like step 14, we just tell them to add target attribute with
_blank
without a code examplehttps://www.freecodecamp.org/learn/2022/responsive-web-design/learn-html-by-building-a-cat-photo-app/step-14
However, this is popular post on the forum where campers don't know what to do and are just guessing at syntax
https://forum.freecodecamp.org/search?q=step%2014%20%23html-css%20after%3A2024-03-01%20cat%20photo%20app
Also, sometimes we have code examples inline like this
https://www.freecodecamp.org/learn/2022/responsive-web-design/learn-html-by-building-a-cat-photo-app/step-10
And then other times we don't.
IMO, we should always follow this format when it comes to introducing new concepts
This PR fixes the code example inconsistencies for new concepts and should help with the number of queries we get on the forum.
Checklist:
main
branch of freeCodeCamp.