Each Concept and Practice Exercise will have to define a blurb, which is a short description of the exercise.
The blurb will be displayed on a track's exercises page and on exercise tooltips. For example:
Blurbs must be limited to 350 chars and will be truncated in some views.
For Practice Exercises that are based on an exercise defined in the problem-specification repo, the blurb must match the contents of the problem-specifications exercises, which is defined in its metadata.yml file. In this PR, we'll do an initial syncing of the blurb. The new configlet version will add support for doing this syncing automatically.
If the Practice Exercise was not based on a problems-specifications exercise, we've used the blurb from its .meta/metadata.yml file as the blurb in the .meta/config.json file.
For Concept Exercises, we've added a placeholder blurb to the .meta/config.json file of each Concept Exercise.
We've opened an issue for replacing the Concept Exercise placeholder blurbs with sensible descriptions. Our recommendation is to merge this PR and then replace the placeholder blurbs in a follow-up PR. For forked exercises, it might be useful to check how other tracks have defined their blurb.
Each Concept and Practice Exercise will have to define a blurb, which is a short description of the exercise. The blurb will be displayed on a track's exercises page and on exercise tooltips. For example:
Blurbs must be limited to 350 chars and will be truncated in some views.
For Practice Exercises that are based on an exercise defined in the problem-specification repo, the blurb must match the contents of the problem-specifications exercises, which is defined in its
metadata.ymlfile. In this PR, we'll do an initial syncing of the blurb. The new configlet version will add support for doing this syncing automatically.If the Practice Exercise was not based on a problems-specifications exercise, we've used the blurb from its
.meta/metadata.ymlfile as the blurb in the .meta/config.json file.For Concept Exercises, we've added a placeholder blurb to the .meta/config.json file of each Concept Exercise.
We've opened an issue for replacing the Concept Exercise placeholder blurbs with sensible descriptions. Our recommendation is to merge this PR and then replace the placeholder blurbs in a follow-up PR. For forked exercises, it might be useful to check how other tracks have defined their blurb.
See the Concept Exercise spec and Practice Exercise spec for more information.
Tracking
https://github.com/exercism/v3-launch/issues/21