Inline the track-wide exercise README insert into the exercise template#519
Inline the track-wide exercise README insert into the exercise template#519ErikSchierboom merged 6 commits intomasterfrom
Conversation
The upstream problem specifications have gotten a number of formatting and whitespace tweaks, as well as some clarifications to the description text. This regenerates all the exercise READMEs to pull in upstream changes.
Now that we have a track-wide template, we can get rid of the docs insert.
Since the template can refer to exercise-specific values, this updates the track-wide submission hint to use the actual name of the exercise directory. It also removes the example submit command, which seems redundant now.
|
Thanks @kytrinyx! @ErikSchierboom I'm not sure how much additional value that submit directory is adding and if we felt there was a lot of value add I'd argue we should try to get it integrated for all of the tracks. What are your thoughts? |
|
I don't think it adds much value. Personally, I'm in favor of just removing it. The Exercism CLI should actually help the user with these kinds of errors I feel. |
Agreed! I'll remove it and push this back up. |
|
Oh. Didn't realize this was merged. I'll submit a new PR :) |
|
Actually, I'll let you all sort it out now that I think of it. Sorry for the noise 🌷 |
|
@kytrinyx One question: is there a tool with which we can regenerate the docs? |
Shoot, yes! 100% absolutely yes :) TL;DR: Long version: |
|
Wonderful, thanks! |
3 participants
Since we now have a track-wide exercise template, I've inlined the markdown README insert in the docs directory into the template.
The first three commits do general cleanup so that the diff when inlining is minimal.
After inlining, I've got a commit that tweaks the inlined text to make it refer to the actual exercise directory name, since the template has access to that value at generation time.
The final commit regenerates all the READMEs using the updated template.
See exercism/meta#94