Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

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

Closed
ErikSchierboom opened this issue Jul 14, 2021 · 0 comments · Fixed by #494
Closed

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

ErikSchierboom opened this issue Jul 14, 2021 · 0 comments · Fixed by #494
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
@ErikSchierboom ErikSchierboom mentioned this issue Aug 19, 2021
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
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
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add shared docs exercism/raku
1 participant
@ErikSchierboom