search

exercism / scala

Exercism exercises in Scala.
https://exercism.org/tracks/scala
MIT License
123 stars 131 forks source link

Extract track-specific help instructions from `config/exercise_readme.go.tmpl` #693

Closed ErikSchierboom closed 2 years ago

ErikSchierboom commented 3 years ago

Each track needs a file that contains track-specific instructions on how to get help. The contents of this document are only presented to the student when using the CLI. This file lives at exercises/shared/.docs/help.md. You almost certainly already have this information, but need to move it to the correct place.

For v2 tracks, this information was (usually) included in the readme template found at config/exercise_readme.go.tmpl. As such, tracks can extract the help instructions from the config/exercise_readme.go.tmpl file to the exercises/shared/.docs/help.md file.

See https://github.com/exercism/csharp/pull/1557/files for an example PR.

Tracking

https://github.com/exercism/v3-launch/issues/50

LarsWestergren commented 2 years ago

This issue can be closed I think, it has already been done. Docs are a bit sparse, but I can look over it as part of https://github.com/exercism/scala/issues/698