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.

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

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

Closed
ErikSchierboom opened this issue Jul 14, 2021 · 2 comments · Fixed by #430
Closed

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

ErikSchierboom opened this issue Jul 14, 2021 · 2 comments · Fixed by #430

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

@verdammelt
Copy link
Member

@ErikShierboom - can you give myself @TheLostLambda some guidance on linking from this help.md file to other track documentation? In the v2 doc we had links, for example pointing to our installation guide at (https://exercism.io/tracks/common-lisp/installation) which in v3 is at (https://exercism.lol/docs/tracks/common-lisp/installation).

Would you suggest retaining links like this or to include that installation guide (or a subset of it) in the help.md file directly?

@ErikSchierboom
Copy link
Member Author

Personally, I would lean towards linking to the installation guide and not including it in the help.md file directly, as the help.md file's contents will be included in every exercise's HELP.md file and is probably only really useful once.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants