exercism / v3

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

[Elixir] Add concept introductions #2982

Closed ErikSchierboom closed 3 years ago

ErikSchierboom commented 3 years ago

We've recently specified that each concept should have its own introduction.md file: https://github.com/exercism/v3-docs/blob/master/anatomy/tracks/concepts.md#file-introductionmd.

This PR tries to automatically add these introduction.md files for each of the concept of your track. It does that as follows:

See https://github.com/exercism/v3/issues/2975

ErikSchierboom commented 3 years ago

/format

angelikatyborska commented 3 years ago

And now we can migrate exercise introductions to include concept introductions, to remove the duplication? Via https://github.com/exercism/v3-docs/blob/master/anatomy/tracks/concept-exercises.md#file-docsintroductionmdtpl-optional ?

It is the track's responsibility to generate the introduction.md when a template file is used.

I don't know what that means. What do we need to do extra?

ErikSchierboom commented 3 years ago

And now we can migrate exercise introductions to include concept introductions, to remove the duplication? Via https://github.com/exercism/v3-docs/blob/master/anatomy/tracks/concept-exercises.md#file-docsintroductionmdtpl-optional ?

You can, but there is one "but" (see response below)

It is the track's responsibility to generate the introduction.md when a template file is used.

I don't know what that means. What do we need to do extra?

Tracks will have to use configlet to generate the introduction.md from a template: https://github.com/exercism/v3-docs/blob/master/anatomy/tracks/configlet/generating-documents.md#document-concept-exercises-introductionmd-file. The Exercism website does not know about the template file and will only look at the introduction.md file. Tracks thus have to run configlet themselves in order to update introduction.md files.

At the moment though, configlet v3 doesn't yet support this generating. We hope to implement this soon.