curriculum icon indicating copy to clipboard operation
curriculum copied to clipboard

Style Guide - Foundations/Installations: Headings and Section Placement

Open thatblindgeye opened this issue 4 years ago • 6 comments

Foundations/Installations

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:
    • [ ] Installation Overview
    • [ ] Prerequisites - Ensure the inline sub-headings are fixed to be properly inline
    • [ ] Text Editors
    • [ ] Command Line Basics - The "Test Drive Your Terminal", "Use the Command Line Like a Pro", and "Opening files in VSCode from the Command Line" headings should be a main heading, not a sub-heading - The level 5 headings using Markdown ##### syntax should be sub-headings using Markdown #### syntax
    • [ ] Setting Up Git

thatblindgeye avatar Mar 28 '22 23:03 thatblindgeye

Is this available to be worked on?

mrmchughes avatar Jul 15 '22 18:07 mrmchughes

Can i work on it?

ZionLG avatar Jul 23 '22 15:07 ZionLG

I'm down to work on this one! @thatblindgeye

TidalSana avatar Aug 01 '22 17:08 TidalSana

Sorry for the delay, y'all! @mrmchughes are you still interested in this issue?

thatblindgeye avatar Aug 06 '22 11:08 thatblindgeye

Yes I am!

mrmchughes avatar Aug 08 '22 17:08 mrmchughes

Hey, are there any issues still available? If so, I'd like to work on it!

marcusicaro avatar Aug 21 '22 21:08 marcusicaro

Apologies for the delay in starting this, the notifying email got buried in my inbox. I'll start working on this in the morning! Excited to get some open source contribution experience!

mrmchughes avatar Sep 29 '22 20:09 mrmchughes

Hi @thatblindgeye, how do I mark an item as completed? I went over the Installation Overview and didn't see anything that needed to be updated per the issue, so I was attempting to check it off.

mrmchughes avatar Sep 30 '22 15:09 mrmchughes

I've gone over the lessons brought up in the issue, and I think they are good to go. I didn't see anything wrong with the Installation Overview lesson, so I'm unsure of how to mark that one off. I've submitted pull requests for the other 4 lessons that required some level of fixing.

mrmchughes avatar Sep 30 '22 18:09 mrmchughes

@thatblindgeye I think this issue is all set, if you could please take a look at the pull requests when you've got a chance

mrmchughes avatar Oct 02 '22 17:10 mrmchughes