Swirlify Revamp Goals

[cansavvy]

1. Make Swirl courses easier to contribute to the SCN
   • Add automated checks to the SCN repository
   • Have rmarkdown::render_site() performed automatically
   • Use OTTR actions to do spell check, url check and preview?
   • Add a pull request template that has a checklist of things that a contributor needs to have when they are adding a course
   • Probably change the settings so people don't have to fork the repo but instead can make pull requests that can't be merged unless the actions pass and we review them
   • Add some issue templates to help guide people when they need to complain about a broken course
   • Have https://github.com/swirldev/scn/blob/gh-pages/title.Rmd and https://github.com/swirldev/scn/blob/gh-pages/surname.Rmd automatically generated.
   • Set up a github action so .swc can be automatically logged as a PR when its edited on a different repository.
2. Add more documentation for how to create swirlify courses
   • Add more examples!
3. Make it easier for swirlify to accommodate different course needs
   • Make it so there can be submodules and modules?
   • Make it so you can pack a bunch of courses at once if you want
   • Fix weirdness regarding set_lesson() Add some documentation about set_lesson  #46 -- is there another way we can have lessons found or specified? The interactivity of set_lesson() is not easy to use.
   • Make it so that multiple lessons can use the same file sets without have a bunch of copies. e.g. initLesson.R, customTests.R, dependson.txt
     • @seankross can we tell swirl where to look for these files so that they don't need to be copied?
   • Make it so skip() can be turned off.
   • Formalize the ability to give credit for completing a lesson. Like what is in https://github.com/datatrail-jhu/datatrail-swirl/blob/main/DataTrail_Complete/DataTrail_02_Getting_Data/Basic_Commands/customTests.R
   • Enable a way to have more tracking
     • @seankross write something about how logging currently works in swirl
       • Logging student's answers -- perhaps just writing them to a googlesheet?
       • Whether or not they have completed it
   • Have a way for students to "test out" of swirl modules.
   • Optionally collect user demographics

• Make it easier to have students build something up over multiple commands
• It's hard to refer back to content -- is there a way to print out a summary of the lesson?
• Multiple choice questions don't allow you to scroll back up to reference what you were doing. Nor do they let you run code before letting you ask them a question.
  I'll be editing this as I continue to think about it.

[cansavvy]

Asking the other educators that I work with what they'd like to see happen on swirl/swirlify. I'll add notes here.