-
-
Notifications
You must be signed in to change notification settings - Fork 551
Description
I found it confusing to get set up to be able to build and preview this lesson locally.
The README links to the old lesson template documentation rather than the Workbench docs, and it took me a while to figure out which part of the Workbench docs was most relevant for making changes to an existing lesson.
I was also confused by the lack of renv.lock file in the repo and tried running renv::snapshot to generate one before realising that there was a lockfile in renv/profiles/lesson-requirements when I then ran sandpaper::serve()/sandpaper::build_lesson().
I think a few lines on how to build lessons locally (along the lines of the "Ten Things You Need To Know" in the old docs) would be really helpful for new/returning contributors! Maybe that's more of a suggestion for the Workbench docs, though? For this repo I think it would still be helpful to link directly to the relevant part of the Workbench docs.