Skip to content
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

Conversation

jdwilkin4
Copy link
Contributor

@jdwilkin4 jdwilkin4 commented Apr 24, 2024

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 example
https://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 example
https://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

  1. teach the concept
  2. show an example. Preferably in a code block.
  3. give the directions on what to do in the project

This PR fixes the code example inconsistencies for new concepts and should help with the number of queries we get on the forum.

Checklist:

@jdwilkin4 jdwilkin4 self-assigned this Apr 24, 2024
@github-actions github-actions bot added the scope: curriculum Lessons, Challenges, Projects and other Curricular Content in curriculum directory. label Apr 24, 2024
Copy link
Member

@naomi-lgbt naomi-lgbt left a 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.

@naomi-lgbt naomi-lgbt added the status: discussing Under discussion threads. Closed as stale after 60 days of inactivity. label Apr 25, 2024
@naomi-lgbt
Copy link
Member

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.

@jdwilkin4
Copy link
Contributor Author

jdwilkin4 commented Apr 25, 2024

@naomi-lgbt

I pushed an update to remove some of the code examples.
And left comments for the others.

We could remove the remaining code examples steps where I left comments and see if updating the hint text and tests will work instead

Copy link
Member

@naomi-lgbt naomi-lgbt left a 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.

@naomi-lgbt naomi-lgbt added status: waiting review To be applied to PR's that are ready for QA, especially when additional review is pending. and removed status: discussing Under discussion threads. Closed as stale after 60 days of inactivity. labels Apr 26, 2024
@naomi-lgbt naomi-lgbt enabled auto-merge (squash) April 26, 2024 05:32
@a2937
Copy link
Member

a2937 commented Apr 26, 2024

Looks Good To Me! 👍

@naomi-lgbt naomi-lgbt merged commit 17eb730 into freeCodeCamp:main Apr 26, 2024
19 of 22 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
scope: curriculum Lessons, Challenges, Projects and other Curricular Content in curriculum directory. status: waiting review To be applied to PR's that are ready for QA, especially when additional review is pending.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants