Update Ozan's playlist exercise introduction

Programming JavaScript
1

Relevant PR

I think the introduction for this exercise was missing crucial information that prevented a learner from completing the task without doing external research. I’ve added additional information that should be sufficient to allow the learner to complete the task without any additional Googling.

  1. The task requires the learner to convert an array to a Set object, which had not been explained how to accomplish in the intro.
  2. The task requires the learner to convert a Set object back to an array, which had also not been explained how to do in the intro.

This PR addresses the 2 aforementioned issues and adds appropriate documentation to the introduction.

2

Change looks fine, but note that the goal is not necessarily for these exercises to be self-sufficient in terms of documentations. In this case I think it makes sense to add the information to the introduction.

3

Approved & Merged.

Thank you for the PR.

4

I see, thanks for clarifying. So what exactly are the goals/conventions then for the documentation? Is there any page where this is outlined?

1 Like
5

First of all: this is a concept exercise. These focus on one specific concept to learn. The goals are outlined in .meta/design.md inside the exercise directory.

Then there is a decision to make: Is the thing you want to document part of the concept to be taught? Then a brief description in the concept documentation (not in the exercise itself) should be made. Is it required for the exercise, but not yet taught in a required previous concept? Then a very short introduction goes into the exercise documentation. And maybe, if it is not that easy for beginners to get to work, add some hints and links to .docs/hints.md of the exercise.

We also have contributor documentation on the exercism website for concept exercises, for concepts and more about the design of a syllabus.

1 Like