Documentation errors

[evaneus]

1. Quickstart (https://pielabs.github.io/pie-website/docs/using/quick-start/):

• a. config.json & index.html links are broken

2. Rendering Items (https://pielabs.github.io/pie-website/docs/using/rendering-items/):

• a. Packaging Tool link in first sentence is broken
• b. The Client Side Example code is incomplete. I tried for a while to get this to run. I was able to get the player included using the -addPlayerAndControlPanel option when packing, but the pie-controller code was then missing. It would be great to have this example working…

3. Packaging Items (https://pielabs.github.io/pie-website/docs/using/packaging-items/):

• a.Documentation refers to "pie.js" when using the -C flag, but I'm seeing "pie-item.js" when I run that command.

4. Pie Player API (https://pielabs.github.io/pie-website/docs/using/pie-player-api/): player.env({view:'gather'})

• a.The link under the "set controller" section is broken: The controller will typically delegate down to the pie elements' controller module and assemble the results. See a ready to roll implemenation here
• b. In the example under the reset method, the "const reset" function should be "const resetPredicate"
• c. The resetResponse function and reset function seem to be duplicates?

5. Development (https://pielabs.github.io/pie-website/docs/developing/development/):

• a. Packaging PIEs link is broken

6. Custom Element (https://pielabs.github.io/pie-website/docs/developing/custom-element/):

• a. The Using Modules link is broken.
• b. The documentation is confusing on which events a PIE should emit:
• i. The documentation indicates a pie should emit the 'pie.register' event in the code example, but later it reads 'register-pie' towards the bottom of the page.
• ii. The documentation indicates a pie should emit the 'model-updated' event in its code example, but in actual code I see 'pie.model-updated'. Also, the model-updated event is not detailed in the bottom section of the documentation like the other events.
• iii. Should the 'model-set' event be namespaced with 'pie.'?
• iv. The sessionChanged event is mentioned in the "set session" section, but is never elaborated on. In actual code, I see a 'pie' event being emitted with a detail.type property of 'sessionChanged'…
• v. I can't find a response-changed event anywhere in code…
• c. The see Controller link is broken.
• d. Uses the term 'view' when it should read 'mode'
• e. The see: Environment link is broken