coderefinery / sphinx-lesson

Sphinx extension for creating CodeRefinery lessons
https://coderefinery.github.io/sphinx-lesson/
MIT License
15 stars 20 forks source link

Settle on what our ideal template repository is #21

Closed rkdarst closed 4 years ago

rkdarst commented 4 years ago

How do we recommend people to get started?
a) We should have some example that is easy to copy and modify to start fresh. b) when converting an existing lesson, there should be some minimal skeleton you can merge --allow-unrelated-histories to bring in all the files you need, but no more.

What we have so far:

bast commented 4 years ago

Less is better. If we want to maintain less, we can have a an "empty" template and we can also point to some real lesson that we use which has grown from the template where people can see and check how this looks in real life and how to implement certain features.

rkdarst commented 4 years ago

I think this i settled, the -empty one was renamed to sphinx-lesson-template and made the recommended starting point