step0 Scope - Keep the welcome paragraph visible after course start?

[sinsukehlab]

Why:

Some learners would like to browse Step 0.

Discussed in https://github.com/orgs/skills/discussions/24

^{Originally posted by **markpatterson27** August 15, 2022} Should the welcome paragraph be included in the step0 scope? The welcome paragraph includes the course details: 'Who is this for', 'What you'll learn', etc. This paragraph is hidden (along with the 'How to start this course' section) when the course is started (i.e. new repo created from template). I think this paragraph is still useful after the course has started and shouldn't be hidden. Before opening a series of PRs, I was wondering what other peoples opinions are. Should the welcome paragraph remain visible after course start, or should it be hidden out of the way?

What's being changed:

I changed the style of Step 0. I put Step 0 in a <details> tag instead of commenting it out.

Check off the following:

• [x] For workflow changes, I have verified the Actions workflows function as expected.
• [x] For content changes, I have reviewed the style guide.

[markpatterson27]

I would leave the <!--step0--> <!--endstep0--> comment blocks in. End state would be to still hide the setup instructions after the course is started, but to put the course aims and LO in a details block.

Something like this

<!--<details id=0><summary>Course Aims</summary>-->

TBD-welcome-paragraph

- **Who is this for**: TBD-audience.
- **What you'll learn**: TBD-objective.
- **What you'll build**: TBD-result.
- **Prerequisites**: TBD-prerequisites.
- **How long**: This course is TBD-step-count steps long and takes less than TBD-duration to complete.

<!--</details>-->

<!--step0-->

The skills/action-update-step would also have to be updated to accommodate for blocks being removed from comments instead of added. (i.e. unhide the details tags).

Personally, I think it's good enough to just move the <!--step0--> to below the course aims (i.e. just above ## How to start this course).

[sinsukehlab]

What do you think of this commit? I don't think skills/action-update-step needs updating for this reason. I think it needs updating for the CI course though. Cf. skills/action-update-step#5

[markpatterson27]

@sinsukehlab Looks ok. Summary title might be better as Course description. My preference is not to put the course aims/description in a <details> tag though (and also take out the summary title).

We need more opinions at this point and ideally we need some one from the GH Skills team to take a look at this and make a decision on if this is a direction they want to go in.

[heiskr]

I've noted this feedback on an internal issue for the product folks to review.

[heiskr]

I've merged something similar in https://github.com/skills/template-template/pull/28, thank you for the recommendation 🙏🏼