Style Guide - Foundations/HTML Foundations: Headings and Section Placement

[thatblindgeye]

Foundations/HTML Foundations

This issue is part of the Style Guide Community Project, a way of offering members of The Odin Project community a chance to contribute to our curriculum. Users who wish to take part and contribute to any Style Guide issues should have thoroughly read the layout style guide and The Odin Project contributing guide.

Description of Issue

This issue ensures that headings are properly formatted and that all sections are placed in the correct order.

Each applicable lesson for this issue should meet the following bulleted requirements:

• The main headings use the Markdown ### syntax.
• Sub-headings that are not inline use the Markdown #### syntax.
• Sub-headings that are inline use the Markdown **sub-heading** (i.e. bold) syntax.
• Both headings and sub-headings use Wikipedia style Title Case.
• There is a newline before and after headings and non-inline sub-headings.
• The order of existing sections follows the below format:
  • Introduction
  • Lesson Overview
  • Custom Sections (lessons) / Pre-Assignment Sections (projects)
  • Assignment
  • Practice (lessons) / Post-Assignment Sections (projects)
  • Knowledge Check
  • Additional Resources
• Additionally, there should be an empty newline at the end of the file.

Acceptance Criteria

• [ ] The following lessons are updated according to the issue description above:
  • [ ] Introduction to HTML and CSS
  • [ ] Elements and Tags
  • [ ] HTML Boilerplate - Remove the code backticks from the "What is the lang attribute?" heading
  • [ ] Working with Text
  • [ ] Lists
  • [ ] Links and Images
  • [ ] Commit Messages
  • [ ] Project: Recipes - The "Tips on when to commit" heading should be a level 3 ### heading

[itsaflamingo]

I can work on this one

[thatblindgeye]

@itsaflamingo all yours!

[itsaflamingo]

Sent in the pull request:) Thank you!

[github-actions[bot]]

This issue is stale because it has had no activity for the last 30 days.

[szmazhr]

can I be assign here?

[Memomer]

Can i be assigned this? or is it resolved?

[thatblindgeye]

@Memomer Someone else is currently working on this, but thank you for wanting to help out! If you'd I'd definitely check out some of the other open issues in our repos.

[Memomer]

@Memomer Someone else is currently working on this, but thank you for wanting to help out! If you'd I'd definitely check out some of the other open issues in our repos.

Ok, I will check out other issues.

[github-actions[bot]]

This issue is stale because it has had no activity for the last 30 days.

[AbhijitSarode]

Is there anything to work on Style Guide? This is my first contribution to open source & I think I can contribute to Style Guide. I am trying to find if I can contribute here but it all seems very over whelming. A gentle guide would be much appreciated 🙏

[rlmoser99]

@thatblindgeye A pull request has been submitted that looks like it resolves the final two issues. This person did not asked to get assigned the issue, but since we've been waiting for quite a while for this one to re resolved, how do you think we should handle this?

[thatblindgeye]

A pull request has been submitted that looks like it resolves the final two issues. This person did not asked to get assigned the issue, but since we've been waiting for quite a while for this one to re resolved, how do you think we should handle this?

The assignee currently has a PR open, just waiting on some changes to be made before merging

[tapilew]

@thatblindgeye So, is this issue already resolved or is there still something I can contribute on?

[CBID2]

@KevinMulhern, is this issue still being addressed? I'd like to work on it

[thatblindgeye]

@tapiadot @CBID2 This issue is currently addressed in an open PR

[CBID2]

@tapiadot @CBID2 This issue is currently addressed in an open PR

It looks like it hasn't been updated in 8 months. From maintainer to maintainer, I highly recommend closing it and let other people work on it. Stale PRs in my experience, causes the workflow to slow down.

[thatblindgeye]

@CBID2 the PR was originally opened then yeah, but the last update was ~a month ago. Currently some merge conflicts awaiting to be done, but did just ping the user for an update. If there's no update soon I'll come back to this issue to see if anyone else whose inquired would still like to open their own PR for it.

[CBID2]

@CBID2 the PR was originally opened then yeah, but the last update was ~a month ago. Currently some merge conflicts awaiting to be done, but did just ping the user for an update. If there's no update soon I'll come back to this issue to see if anyone else whose inquired would still like to open their own PR for it.

Good plan. With that in mind, I reiterate my interest in solving this problem @thatblindgeye. I'm very new to this repo so I want to start with something easier to solve :)

[thatblindgeye]

@CBID2 ++ definitely appreciate it! Will keep that in mind for future issues as well

[CBID2]

@CBID2 ++ definitely appreciate it! Will keep that in mind for future issues as well

Ooh speaking of issues, I raised this one. I’d love to see your viewpoint on it.

[CBID2]

Hey @thatblindgeye! :) I'm back! :) Have you heard any updates from the other contributor who started there PR for this issue?

[CouchofTomato]

@CBID2

You can see the linked pull request just above your comment.

[CBID2]

@CBID2

You can see the linked pull request just above your comment.

See this reply @CouchofTomato.

[CouchofTomato]

It's a different PR https://github.com/TheOdinProject/curriculum/pull/25682

[CBID2]

It's a different PR https://github.com/TheOdinProject/curriculum/pull/25682

Thanks for the update @CouchofTomato! :)

[thatblindgeye]

Closing as completed in #25692