Beef up the documentation here -- add examples!

jhudsl / ottrpal

Tools for converting OTTR courses into Leanpub or Coursera courses :otter:

https://jhudatascience.org/ottrpal/

GNU General Public License v3.0

3 stars 1 forks source link

Beef up the documentation here -- add examples! #10

Closed cansavvy closed 3 years ago

cansavvy commented 3 years ago

Once we get a better handle of what this package can do we should write it down and make some brief examples that show how to use it. It's a bit daunting to approach as is.

Some things we should illustrate:

What files are needed? (Seems like all the bookdown files)
What can this package do?
How should said files be set up?
How does one use this with Leanpub?
What are the other time savers this package has?

cansavvy commented 3 years ago

This is done for now!