Sync docs and metadata (#323)

Author: glennj

exercises/practice/affine-cipher/.docs/instructions.md

@@ -4,7 +4,7 @@ Create an implementation of the affine cipher, an ancient encryption system crea
 
 The affine cipher is a type of monoalphabetic substitution cipher.
 Each character is mapped to its numeric equivalent, encrypted with a mathematical function and then converted to the letter relating to its new numeric value.
-Although all monoalphabetic ciphers are weak, the affine cipher is much stronger than the atbash cipher, because it has many more keys.
+Although all monoalphabetic ciphers are weak, the affine cipher is much stronger than the Atbash cipher, because it has many more keys.
 
 [//]: # " monoalphabetic as spelled by Merriam-Webster, compare to polyalphabetic "
 
@@ -18,10 +18,10 @@ E(x) = (ai + b) mod m
 
 Where:
 
-- `i` is the letter's index from `0` to the length of the alphabet - 1
+- `i` is the letter's index from `0` to the length of the alphabet - 1.
 - `m` is the length of the alphabet.
   For the Roman alphabet `m` is `26`.
-- `a` and `b` are integers which make the encryption key
+- `a` and `b` are integers which make up the encryption key.
 
 Values `a` and `m` must be _coprime_ (or, _relatively prime_) for automatic decryption to succeed, i.e., they have number `1` as their only common factor (more information can be found in the [Wikipedia article about coprime integers][coprime-integers]).
 In case `a` is not coprime to `m`, your program should indicate that this is an error.

exercises/practice/atbash-cipher/.docs/instructions.md

@@ -1,6 +1,6 @@
 # Instructions
 
-Create an implementation of the atbash cipher, an ancient encryption system created in the Middle East.
+Create an implementation of the Atbash cipher, an ancient encryption system created in the Middle East.
 
 The Atbash cipher is a simple substitution cipher that relies on transposing all the letters in the alphabet such that the resulting alphabet is backwards.
 The first letter is replaced with the last letter, the second with the second-last, and so on.

exercises/practice/atbash-cipher/.meta/config.json

@@ -19,7 +19,7 @@
       ".meta/example.sml"
     ]
   },
-  "blurb": "Create an implementation of the atbash cipher, an ancient encryption system created in the Middle East.",
+  "blurb": "Create an implementation of the Atbash cipher, an ancient encryption system created in the Middle East.",
   "source": "Wikipedia",
   "source_url": "https://en.wikipedia.org/wiki/Atbash"
 }

exercises/practice/darts/.docs/instructions.md

@@ -1,6 +1,6 @@
 # Instructions
 
-Write a function that returns the earned points in a single toss of a Darts game.
+Calculate the points scored in a single toss of a Darts game.
 
 [Darts][darts] is a game where players throw darts at a [target][darts-target].
 
@@ -16,7 +16,7 @@ In our particular instance of the game, the target rewards 4 different amounts o
 The outer circle has a radius of 10 units (this is equivalent to the total radius for the entire target), the middle circle a radius of 5 units, and the inner circle a radius of 1.
 Of course, they are all centered at the same point — that is, the circles are [concentric][] defined by the coordinates (0, 0).
 
-Write a function that given a point in the target (defined by its [Cartesian coordinates][cartesian-coordinates] `x` and `y`, where `x` and `y` are [real][real-numbers]), returns the correct amount earned by a dart landing at that point.
+Given a point in the target (defined by its [Cartesian coordinates][cartesian-coordinates] `x` and `y`, where `x` and `y` are [real][real-numbers]), calculate the correct score earned by a dart landing at that point.
 
 ## Credit
 

exercises/practice/darts/.meta/config.json

@@ -13,6 +13,6 @@
       ".meta/example.sml"
     ]
   },
-  "blurb": "Write a function that returns the earned points in a single toss of a Darts game.",
+  "blurb": "Calculate the points scored in a single toss of a Darts game.",
   "source": "Inspired by an exercise created by a professor Della Paolera in Argentina"
 }

exercises/practice/eliuds-eggs/.docs/introduction.md

@@ -12,36 +12,54 @@ The position information encoding is calculated as follows:
 2. Convert the number from binary to decimal.
 3. Show the result on the display.
 
-Example 1:
+## Example 1
+
+![Seven individual nest boxes arranged in a row whose first, third, fourth and seventh nests each have a single egg.](https://assets.exercism.org/images/exercises/eliuds-eggs/example-1-coop.svg)
 
 ```text
-Chicken Coop:
  _ _ _ _ _ _ _
 |E| |E|E| | |E|
+```
+
+### Resulting Binary
+
+![1011001](https://assets.exercism.org/images/exercises/eliuds-eggs/example-1-binary.svg)
+
+```text
+ _ _ _ _ _ _ _
+|1|0|1|1|0|0|1|
+```
 
-Resulting Binary:
- 1 0 1 1 0 0 1
+### Decimal number on the display
 
-Decimal number on the display:
 89
 
-Actual eggs in the coop:
+### Actual eggs in the coop
+
 4
+
+## Example 2
+
+![Seven individual nest boxes arranged in a row where only the fourth nest has an egg.](https://assets.exercism.org/images/exercises/eliuds-eggs/example-2-coop.svg)
+
+```text
+ _ _ _ _ _ _ _
+| | | |E| | | |
 ```
 
-Example 2:
+### Resulting Binary
+
+![0001000](https://assets.exercism.org/images/exercises/eliuds-eggs/example-2-binary.svg)
 
 ```text
-Chicken Coop:
- _ _ _ _ _ _ _ _
-| | | |E| | | | |
+ _ _ _ _ _ _ _
+|0|0|0|1|0|0|0|
+```
 
-Resulting Binary:
- 0 0 0 1 0 0 0 0
+### Decimal number on the display
 
-Decimal number on the display:
 16
 
-Actual eggs in the coop:
+### Actual eggs in the coop
+
 1
-```

exercises/practice/eliuds-eggs/.meta/config.json

@@ -15,5 +15,5 @@
   },
   "blurb": "Help Eliud count the number of eggs in her chicken coop by counting the number of 1 bits in a binary representation.",
   "source": "Christian Willner, Eric Willigers",
-  "source_url": "https://forum.exercism.org/t/new-exercise-suggestion-eliuds-eggs/7632/5"
+  "source_url": "https://forum.exercism.org/t/new-exercise-suggestion-pop-count/7632/5"
 }

exercises/practice/flatten-array/.docs/instructions.md

@@ -2,7 +2,7 @@
 
 Take a nested list and return a single flattened list with all values except nil/null.
 
-The challenge is to write a function that accepts an arbitrarily-deep nested list-like structure and returns a flattened structure without any nil/null values.
+The challenge is to take an arbitrarily-deep nested list-like structure and produce a flattened structure without any nil/null values.
 
 For example:
 

exercises/practice/hamming/.docs/instructions.md

@@ -1,26 +1,15 @@
 # Instructions
 
-Calculate the Hamming Distance between two DNA strands.
+Calculate the Hamming distance between two DNA strands.
 
-Your body is made up of cells that contain DNA.
-Those cells regularly wear out and need replacing, which they achieve by dividing into daughter cells.
-In fact, the average human body experiences about 10 quadrillion cell divisions in a lifetime!
-
-When cells divide, their DNA replicates too.
-Sometimes during this process mistakes happen and single pieces of DNA get encoded with the incorrect information.
-If we compare two strands of DNA and count the differences between them we can see how many mistakes occurred.
-This is known as the "Hamming Distance".
-
-We read DNA using the letters C,A,G and T.
+We read DNA using the letters C, A, G and T.
 Two strands might look like this:
 
     GAGCCTACTAACGGGAT
     CATCGTAATGACGGCCT
     ^ ^ ^  ^ ^    ^^
 
-They have 7 differences, and therefore the Hamming Distance is 7.
-
-The Hamming Distance is useful for lots of things in science, not just biology, so it's a nice phrase to be familiar with :)
+They have 7 differences, and therefore the Hamming distance is 7.
 
 ## Implementation notes
 

exercises/practice/hamming/.docs/introduction.md

@@ -0,0 +1,12 @@
+# Introduction
+
+Your body is made up of cells that contain DNA.
+Those cells regularly wear out and need replacing, which they achieve by dividing into daughter cells.
+In fact, the average human body experiences about 10 quadrillion cell divisions in a lifetime!
+
+When cells divide, their DNA replicates too.
+Sometimes during this process mistakes happen and single pieces of DNA get encoded with the incorrect information.
+If we compare two strands of DNA and count the differences between them, we can see how many mistakes occurred.
+This is known as the "Hamming distance".
+
+The Hamming distance is useful in many areas of science, not just biology, so it's a nice phrase to be familiar with :)

exercises/practice/hamming/.meta/config.json

@@ -20,7 +20,7 @@
       ".meta/example.sml"
     ]
   },
-  "blurb": "Calculate the Hamming difference between two DNA strands.",
+  "blurb": "Calculate the Hamming distance between two DNA strands.",
   "source": "The Calculating Point Mutations problem at Rosalind",
   "source_url": "https://rosalind.info/problems/hamm/"
 }

exercises/practice/knapsack/.docs/instructions.md

@@ -1,11 +1,11 @@
 # Instructions
 
-Your task is to determine which items to take so that the total value of his selection is maximized, taking into account the knapsack's carrying capacity.
+Your task is to determine which items to take so that the total value of her selection is maximized, taking into account the knapsack's carrying capacity.
 
 Items will be represented as a list of items.
 Each item will have a weight and value.
 All values given will be strictly positive.
-Bob can take only one of each item.
+Lhakpa can take only one of each item.
 
 For example:
 
@@ -21,5 +21,5 @@ Knapsack Maximum Weight: 10
 ```
 
 For the above, the first item has weight 5 and value 10, the second item has weight 4 and value 40, and so on.
-In this example, Bob should take the second and fourth item to maximize his value, which, in this case, is 90.
-He cannot get more than 90 as his knapsack has a weight limit of 10.
+In this example, Lhakpa should take the second and fourth item to maximize her value, which, in this case, is 90.
+She cannot get more than 90 as her knapsack has a weight limit of 10.

exercises/practice/knapsack/.docs/introduction.md

@@ -1,8 +1,10 @@
 # Introduction
 
-Bob is a thief.
-After months of careful planning, he finally manages to crack the security systems of a fancy store.
+Lhakpa is a [Sherpa][sherpa] mountain guide and porter.
+After months of careful planning, the expedition Lhakpa works for is about to leave.
+She will be paid the value she carried to the base camp.
 
-In front of him are many items, each with a value and weight.
-Bob would gladly take all of the items, but his knapsack can only hold so much weight.
-Bob has to carefully consider which items to take so that the total value of his selection is maximized.
+In front of her are many items, each with a value and weight.
+Lhakpa would gladly take all of the items, but her knapsack can only hold so much weight.
+
+[sherpa]: https://en.wikipedia.org/wiki/Sherpa_people#Mountaineering

exercises/practice/luhn/.docs/instructions.md

@@ -22,7 +22,8 @@ The first step of the Luhn algorithm is to double every second digit, starting f
 We will be doubling
 
 ```text
-4_3_ 3_9_ 0_4_ 6_6_
+4539 3195 0343 6467
+↑ ↑  ↑ ↑  ↑ ↑  ↑ ↑  (double these)
 ```
 
 If doubling the number results in a number greater than 9 then subtract 9 from the product.

exercises/practice/matching-brackets/.docs/instructions.md

@@ -1,4 +1,5 @@
 # Instructions
 
 Given a string containing brackets `[]`, braces `{}`, parentheses `()`, or any combination thereof, verify that any and all pairs are matched and nested correctly.
-The string may also contain other characters, which for the purposes of this exercise should be ignored.
+Any other characters should be ignored.
+For example, `"{what is (42)}?"` is balanced and `"[text}"` is not.

exercises/practice/matching-brackets/.docs/introduction.md

@@ -0,0 +1,8 @@
+# Introduction
+
+You're given the opportunity to write software for the Bracketeer™, an ancient but powerful mainframe.
+The software that runs on it is written in a proprietary language.
+Much of its syntax is familiar, but you notice _lots_ of brackets, braces and parentheses.
+Despite the Bracketeer™ being powerful, it lacks flexibility.
+If the source code has any unbalanced brackets, braces or parentheses, the Bracketeer™ crashes and must be rebooted.
+To avoid such a scenario, you start writing code that can verify that brackets, braces, and parentheses are balanced before attempting to run it on the Bracketeer™.

exercises/practice/pascals-triangle/.docs/instructions.md

@@ -1,14 +1,35 @@
 # Instructions
 
-Compute Pascal's triangle up to a given number of rows.
+Your task is to output the first N rows of Pascal's triangle.
 
-In Pascal's Triangle each number is computed by adding the numbers to the right and left of the current position in the previous row.
+[Pascal's triangle][wikipedia] is a triangular array of positive integers.
+
+In Pascal's triangle, the number of values in a row is equal to its row number (which starts at one).
+Therefore, the first row has one value, the second row has two values, and so on.
+
+The first (topmost) row has a single value: `1`.
+Subsequent rows' values are computed by adding the numbers directly to the right and left of the current position in the previous row.
+
+If the previous row does _not_ have a value to the left or right of the current position (which only happens for the leftmost and rightmost positions), treat that position's value as zero (effectively "ignoring" it in the summation).
+
+## Example
+
+Let's look at the first 5 rows of Pascal's Triangle:
 
 ```text
     1
    1 1
   1 2 1
  1 3 3 1
 1 4 6 4 1
-# ... etc
 ```
+
+The topmost row has one value, which is `1`.
+
+The leftmost and rightmost values have only one preceding position to consider, which is the position to its right respectively to its left.
+With the topmost value being `1`, it follows from this that all the leftmost and rightmost values are also `1`.
+
+The other values all have two positions to consider.
+For example, the fifth row's (`1 4 6 4 1`) middle value is `6`, as the values to its left and right in the preceding row are `3` and `3`:
+
+[wikipedia]: https://en.wikipedia.org/wiki/Pascal%27s_triangle

exercises/practice/pascals-triangle/.docs/introduction.md

@@ -0,0 +1,22 @@
+# Introduction
+
+With the weather being great, you're not looking forward to spending an hour in a classroom.
+Annoyed, you enter the class room, where you notice a strangely satisfying triangle shape on the blackboard.
+Whilst waiting for your math teacher to arrive, you can't help but notice some patterns in the triangle: the outer values are all ones, each subsequent row has one more value than its previous row and the triangle is symmetrical.
+Weird!
+
+Not long after you sit down, your teacher enters the room and explains that this triangle is the famous [Pascal's triangle][wikipedia].
+
+Over the next hour, your teacher reveals some amazing things hidden in this triangle:
+
+- It can be used to compute how many ways you can pick K elements from N values.
+- It contains the Fibonacci sequence.
+- If you color odd and even numbers differently, you get a beautiful pattern called the [Sierpiński triangle][wikipedia-sierpinski-triangle].
+
+The teacher implores you and your classmates to lookup other uses, and assures you that there are lots more!
+At that moment, the school bell rings.
+You realize that for the past hour, you were completely absorbed in learning about Pascal's triangle.
+You quickly grab your laptop from your bag and go outside, ready to enjoy both the sunshine _and_ the wonders of Pascal's triangle.
+
+[wikipedia]: https://en.wikipedia.org/wiki/Pascal%27s_triangle
+[wikipedia-sierpinski-triangle]: https://en.wikipedia.org/wiki/Sierpi%C5%84ski_triangle

exercises/practice/pig-latin/.docs/instructions.md

@@ -19,7 +19,7 @@ For example:
 
 ## Rule 2
 
-If a word begins with a one or more consonants, first move those consonants to the end of the word and then add an `"ay"` sound to the end of the word.
+If a word begins with one or more consonants, first move those consonants to the end of the word and then add an `"ay"` sound to the end of the word.
 
 For example:
 
@@ -33,7 +33,7 @@ If a word starts with zero or more consonants followed by `"qu"`, first move tho
 
 For example:
 
-- `"quick"` -> `"ickqu"` -> `"ay"` (starts with `"qu"`, no preceding consonants)
+- `"quick"` -> `"ickqu"` -> `"ickquay"` (starts with `"qu"`, no preceding consonants)
 - `"square"` -> `"aresqu"` -> `"aresquay"` (starts with one consonant followed by `"qu`")
 
 ## Rule 4

exercises/practice/protein-translation/.docs/instructions.md

@@ -2,12 +2,12 @@
 
 Translate RNA sequences into proteins.
 
-RNA can be broken into three nucleotide sequences called codons, and then translated to a polypeptide like so:
+RNA can be broken into three-nucleotide sequences called codons, and then translated to a protein like so:
 
 RNA: `"AUGUUUUCU"` => translates to
 
 Codons: `"AUG", "UUU", "UCU"`
-=> which become a polypeptide with the following sequence =>
+=> which become a protein with the following sequence =>
 
 Protein: `"Methionine", "Phenylalanine", "Serine"`
 
@@ -27,9 +27,9 @@ Protein: `"Methionine", "Phenylalanine", "Serine"`
 
 Note the stop codon `"UAA"` terminates the translation and the final methionine is not translated into the protein sequence.
 
-Below are the codons and resulting Amino Acids needed for the exercise.
+Below are the codons and resulting amino acids needed for the exercise.
 
-| Codon              | Protein       |
+| Codon              | Amino Acid    |
 | :----------------- | :------------ |
 | AUG                | Methionine    |
 | UUU, UUC           | Phenylalanine |

exercises/practice/pythagorean-triplet/.docs/instructions.md

@@ -1,4 +1,4 @@
-# Instructions
+# Description
 
 A Pythagorean triplet is a set of three natural numbers, {a, b, c}, for which,
 

exercises/practice/pythagorean-triplet/.docs/introduction.md

@@ -0,0 +1,19 @@
+# Introduction
+
+You are an accomplished problem-solver, known for your ability to tackle the most challenging mathematical puzzles.
+One evening, you receive an urgent letter from an inventor called the Triangle Tinkerer, who is working on a groundbreaking new project.
+The letter reads:
+
+> Dear Mathematician,
+>
+> I need your help.
+> I am designing a device that relies on the unique properties of Pythagorean triplets — sets of three integers that satisfy the equation a² + b² = c².
+> This device will revolutionize navigation, but for it to work, I must program it with every possible triplet where the sum of a, b, and c equals a specific number, N.
+> Calculating these triplets by hand would take me years, but I hear you are more than up to the task.
+>
+> Time is of the essence.
+> The future of my invention — and perhaps even the future of mathematical innovation — rests on your ability to solve this problem.
+
+Motivated by the importance of the task, you set out to find all Pythagorean triplets that satisfy the condition.
+Your work could have far-reaching implications, unlocking new possibilities in science and engineering.
+Can you rise to the challenge and make history?