exercism / v3

The work-in-progress project for developing v3 tracks
https://v3.exercism.io
Other
170 stars 163 forks source link

[All] Cleanup instructions headings #3002

Closed ErikSchierboom closed 3 years ago

ErikSchierboom commented 3 years ago

Now that we no longer require the introduction.md file to have headings for the concepts, we can now clean the existing introduction.md files up a bit. In this PR, I've done two things:

  1. Removed the concept heading entirely if the exercise has only one concept, as the heading doesn't really brings us anything.
  2. Replace the concept heading slug with the concept name if the exercise has multiple concepts, as the headings do can be very useful.
angelikatyborska commented 3 years ago

I kinda like it when all exercises always have all concept heading. It's consistent and neatly structured. Can I keep Elixir's?

iHiD commented 3 years ago

I still don't really get where we are because we've had so many changes to these files

There's no magic of headings or anything like that at all now.

This PR effectively is just tidying things back up.


I kinda like it when all exercises always have all concept heading. It's consistent and neatly structured. Can I keep Elixir's?

Yes. That's fine. Tracks can decide. I personally prefer without as there is already an "Introduction" heading that these sit under the UI and I don't love headings followed by headings. But I don't think we should enforce a standard here.

@ErikSchierboom - could you change this PR for Elixir, please, so that it doesn't remove first-line headings.

ErikSchierboom commented 3 years ago

@ErikSchierboom - could you change this PR for Elixir, please, so that it doesn't remove first-line headings.

I can. But just to be sure, you still want that @angelikatyborska after reading:

Yes. That's fine. Tracks can decide. I personally prefer without as there is already an "Introduction" heading that these sit under the UI and I don't love headings followed by headings. But I don't think we should enforce a standard here.

?

edit: it might also be good to see what it looks like in the UI

ErikSchierboom commented 3 years ago

Thanks for the reviews!

@angelikatyborska I've created an exception for Elixir to add the headings to introductions for exercises with just one concept