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

Fundamentals Part 1: Update list items to layout styling guide #27141

Merged

Conversation

Churtified
Copy link
Contributor

@Churtified Churtified commented Jan 16, 2024

Because

There are many lessons that have inconsistent styling techniques. By correcting the list items to a unified method, this makes all markdown documents consistent, easier to read, and edit in the future.

This PR

  • Updated all unordered list items from asterisks to the recommended hyphen.
  • Updates all ordered list items from incrementing numbers to lazy numbering format.

Issue

Related to #27119

Additional Information

Pull Request Requirements

  • I have thoroughly read and understand The Odin Project 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

As per style guide, changed all asterisks to hyphens for all unordered list items

This is so the markdown is consistent, even though either would render the same
As per style guide, lazy numbering is preferred and is consistent with all other markdown documents.
@github-actions github-actions bot added the Content: Foundations Involves the Foundations content label Jan 16, 2024
Copy link
Contributor

@thatblindgeye thatblindgeye left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for making the update and also resolving some of the lint errors! Would you want to resolve some of the remaining ones (blanks lines around headings, using asterisk syntax for strong/emphasis instead of underline)?

Also can you just update your comment from Closes [issue number] to Related to [issue number], we don't want this PR automatically closing the issue since it's tied to several lessons.

@Churtified
Copy link
Contributor Author

Thanks, I was confused at the markdown lint. But now I understand what it is! I have made all the changes and changed to Related to [issue number]. Appreciate the feedback.

Copy link
Contributor

@thatblindgeye thatblindgeye left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Understandable! It's a new addition to the repo to help automate the process of finding these issues (rather than having to manually sift through lessons and find what needs to be updated). Thanks again for making these updates!

@thatblindgeye thatblindgeye merged commit e6bd40c into TheOdinProject:main Jan 18, 2024
3 checks passed
@Churtified Churtified deleted the update_lists_to_styles_guide branch March 1, 2024 02:52
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