Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Meta issue on creating documentation #49

Closed
betatim opened this issue Dec 19, 2018 · 1 comment
Closed

Meta issue on creating documentation #49

betatim opened this issue Dec 19, 2018 · 1 comment

Comments

@betatim
Copy link
Collaborator

betatim commented Dec 19, 2018

We will create a clean, new, simple example repository (the course-starter repo) that people can use to start a new course. It will contain:

  • two or three simple notebooks/assignments that show off how to create private/public tests, different points per assignment
  • explanation of what can and can't be in different cells (depending on what tag they have)
  • markdown explanation of how to create tests, comments, stuff
  • annotated but with gaps config.yml that will be filled out by readers when they follow the quick start

Create a way to have a "dummy-student" directory locally that you can "distribute" to and then "grade". It would allow the instructor to pretend to be a student, attempt the assignment, see what the assigned grade is.


There will be a quick start guide (hackmd to get going) to walk people through the process of creating a new class based on the quick start repository.

  • will walk reader through the process of starting from the course-starter repo and end with them having a fully working course
  • instructions for simulating the grading/rendering of the student notebook

This quick start guide will be part of the documentation (RTDs) that is in this repository.


There will be additional documentation about the components in this repository as well.

@lwasser
Copy link

lwasser commented Jan 20, 2022

closing this as we have redone the documentation!

@lwasser lwasser closed this as completed Jan 20, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants