Skip to content
This repository has been archived by the owner on May 30, 2023. It is now read-only.

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

Open
ErikSchierboom opened this issue Jul 14, 2021 · 0 comments
Labels
x:action/improve Improve existing functionality/content x:knowledge/elementary Little Exercism knowledge required x:size/tiny Tiny amount of work x:type/docs Work on Documentation

Comments

@ErikSchierboom
Copy link
Member

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

exercism/v3-launch#50

@ErikSchierboom ErikSchierboom added x:action/improve Improve existing functionality/content x:knowledge/elementary Little Exercism knowledge required x:size/tiny Tiny amount of work x:type/docs Work on Documentation labels Aug 18, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
x:action/improve Improve existing functionality/content x:knowledge/elementary Little Exercism knowledge required x:size/tiny Tiny amount of work x:type/docs Work on Documentation
Projects
None yet
Development

No branches or pull requests

1 participant