Improvements For The Hapipal Tutorial

[Attyboy]

General Suggestions:

All links open on the current tab. It may be easier for the user if all links opened in new tabs. The links provide information necessary for the rest of the tutorial and it is useful to transfer between the tutorial and the linked information.

To make the tutorial more friendly to users unfamiliar to the development world it may be useful to provide links to the technical phrases in the tutorial. Examples: Routes, CLI, Linting, SQL, ORM, etc..

Specific Fixes:

The paragraph:

“But for now we just need to outfit this file so it allows Paldo to broadcast a riddle, chosen at random from the complete archives, to any friends interested in a brain-teaser.”

Could be improved by replacing “this file” with the file name or including the file path in parenthesis. I found it confusing to split off to the description of hapi’s “route configuration object” and return to the main topic without a reference to the file name.

In the “Manual Linting Section” the process of discovering linting errors is discussed but the easy fix process is left out. I think it would be useful to include the syntax for the command line —fix function and how to use it.

At the end of the tutorial the project link is included at: http://0.0.0.0:3000/documentation. I think it would be nice to include the users’ project link throughout the tutorial. So instead of appearing as text like this: http://localhost:3000/riddle-answer/no-body, it will appear as a clickable link that opens a new tab: http://localhost:3000/riddle-answer/no-body.

It is important to communicate to the user that “npm install” must be run after importing flavors. Many errors can be avoided.

This isn’t a big deal but it threw me off that sometimes the command line code listed in the tutorial included a $ at the beginning and sometimes omitted it. At first I tried to write the command code with the $ and got errors, this may not affect a more intermediate programmer.

Comments:

I really enjoyed this tutorial! I loved having a little storyline about Paldo and their riddles. It made the whole tutorial flow for me. With a very limited programming background I was able to complete this tutorial! That’s saying something! I love that all the necessary commands are written out in the tutorial itself.