shaka-player icon indicating copy to clipboard operation
shaka-player copied to clipboard

Investigate Tools For Tutorials

Open vaage opened this issue 6 years ago • 1 comments

It has been a while since we looked at how we write our tutorials. Right now it can be hard to keep code up-to-date in our tutorials as we make changes in the library and it can be easy to let mistakes into the code in the tutorials.

Right now we are using JSDoc, but are there any other tools we can use to help us write tutorials?

Some nice to haves would be:

  • "Get Full Code" from any point in the tutorial.
  • Compile checks and tests for our tutorial code.
  • Warnings when we change code/apis references in the tutorials.

vaage avatar Oct 08 '18 21:10 vaage