Skip to content

Conversation

zunaid-hassan
Copy link
Contributor

@zunaid-hassan zunaid-hassan commented Sep 27, 2025

Lesson: Link (highlighted)

Make the instructions for assignment no. 1 explicitly clear as to which section requires reading.

Because

Make the assignment requirement explicitly clear regarding which sub-section needs to be studied, by writing the name of the sub-section.

This PR

  • Adds the text "(7.1.1. Basic Values of 'flex')" after the document link.

Changes:

Read W3C’s flex section to understand the basic values of common flex shorthand values.

To:

Read W3C’s flex section (7.1.1. Basic Values of 'flex') to understand the basic values of common flex shorthand values.

Issue

Closes #XXXXX

Additional Information

A Discord exchange of a student getting demotivated due to misunderstanding the requirement and thinking they need to read the whole document (17,000 words by their estimation): https://discord.com/channels/505093832157691914/505093832157691916/1421431981647855707

Pull Request Requirements

  • I have thoroughly read and understand The Odin Project curriculum contributing guide
  • The title of this PR follows the location of change: brief description of change format, e.g. Intro to HTML and CSS lesson: Fix link text
  • The Because section summarizes the reason for this PR
  • The This PR section has a bullet point list describing the changes in this PR
  • If this PR addresses an open issue, it is linked in the Issue section
  • If any lesson files are included in this PR, they have been previewed with the Markdown preview tool to ensure it is formatted correctly
  • If any lesson files are included in this PR, they follow the Layout Style Guide

Make the reading assignment TheOdinProject#1 explicitly
clear as to which section requires reading
@github-actions github-actions bot added the Content: Foundations Involves the Foundations content label Sep 27, 2025
Add apostrophes to match the original document style
@karimdevelops
Copy link
Contributor

Not a maintainer, but another purpose of TOP is make the students capable of reading Docs. They should figure out themselves how to skim through Docs, what's important and what's not. It is probably intended this way.

@zunaid-hassan
Copy link
Contributor Author

Not a maintainer, but another purpose of TOP is make the students capable of reading Docs. They should figure out themselves how to skim through Docs, what's important and what's not. It is probably intended this way.

@karimdevelops Thanks for your response.

As I understand it, the assignment instructs to read a specific sub-section of the document, and not skim through the document. The link given also points to that sub-section: https://www.w3.org/TR/css-flexbox-1/#flex-common.

@karimdevelops
Copy link
Contributor

I see now, I misunderstood earlier. You are keeping up with the consistency which looks fine then, however, as far as I remember, they generally don't write section names in brackets with links. It's more of a preference thing and up to them I guess haha.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Content: Foundations Involves the Foundations content
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants