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

Add syllabus docs #369

Merged
merged 44 commits into from
Sep 19, 2022
Merged

Add syllabus docs #369

merged 44 commits into from
Sep 19, 2022

Conversation

ErikSchierboom
Copy link
Member

@ErikSchierboom ErikSchierboom commented Aug 12, 2022

Fixes #367

ErikSchierboom and others added 10 commits July 6, 2022 17:13
This is in no way complete.

I'm trying to give enough background for people to be able to
think about syllabus design in a way that is useful and not
too overwhelming.
The core activity of syllabus design is getting the
concept tree right.

This is very tricky, and we recommend taking it in several
smaller stages.

This gives some suggestions for how to think about each stage.
Add section about selecting or coming up with stories
for concept exercises.
This moves the community contributions section to the bottom
of the document and tweaks the wording a bit.

We will need to add a new subsection to this part about
creating issues for concepts and exercises.
@kytrinyx
Copy link
Member

Think of concepts in layers

I haven't said anything about this explicitly, as I'm encouraging people to implement in layers, which I think will naturally help them think like this.

We haven't figured this out yet; at least not to our satisfaction.

Until we get a better handle on this, just encourage people to talk to us.
@kytrinyx
Copy link
Member

Okay, I have a very, very rough draft of some documentation about syllabus design.

@junedev @angelikatyborska @SleeplessByte would you be willing to take a look at this and provide some initial feedback before we get more eyes on it?

Copy link
Member

@junedev junedev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@kytrinyx I really like what's there already. It resonates well with my understanding and the way it is described it hopefully lowers the barrier to get started for others. Well done!

I left the comments that came to my mind (besides all the "Yes, exactly!" feelings mentioned above). I hope they are not too nit-picky for the state of the draft. It is a bit hard to tell sometimes what exactly to already comment on.

building/tracks/syllabus/README.md Outdated Show resolved Hide resolved
building/tracks/syllabus/README.md Outdated Show resolved Hide resolved
building/tracks/syllabus/README.md Show resolved Hide resolved
building/tracks/syllabus/README.md Outdated Show resolved Hide resolved
building/tracks/syllabus/README.md Show resolved Hide resolved
building/tracks/syllabus/first-exercise.md Outdated Show resolved Hide resolved
building/tracks/syllabus/next-exercises.md Outdated Show resolved Hide resolved
building/tracks/syllabus/next-exercises.md Outdated Show resolved Hide resolved
building/tracks/syllabus/next-exercises.md Outdated Show resolved Hide resolved
building/tracks/syllabus/next-exercises.md Show resolved Hide resolved
building/tracks/syllabus/README.md Outdated Show resolved Hide resolved
building/tracks/syllabus/README.md Show resolved Hide resolved
building/tracks/syllabus/README.md Outdated Show resolved Hide resolved
building/tracks/syllabus/README.md Outdated Show resolved Hide resolved
building/tracks/syllabus/README.md Outdated Show resolved Hide resolved
building/tracks/syllabus/README.md Outdated Show resolved Hide resolved
building/tracks/syllabus/README.md Outdated Show resolved Hide resolved
building/tracks/syllabus/README.md Show resolved Hide resolved
kytrinyx and others added 8 commits August 30, 2022 17:14
Co-authored-by: Erik Schierboom <erik_schierboom@hotmail.com>
Co-authored-by: Erik Schierboom <erik_schierboom@hotmail.com>
Co-authored-by: Erik Schierboom <erik_schierboom@hotmail.com>
Co-authored-by: Erik Schierboom <erik_schierboom@hotmail.com>
@kytrinyx
Copy link
Member

kytrinyx commented Sep 7, 2022

Alright, I've reworked this. I think it might be okay as a first step, and we can iterate on it in smaller steps as we learn more about this whole process.

I'm also planning on taking a stab at the "how to develop a concept exercise" which is tightly related to this documentation (and I may end up extracting some parts of this for the concept exercise documentation).

Thoughts? Good to merge for now? Or any glaring omissions or weirdnesses?

@kytrinyx kytrinyx marked this pull request as ready for review September 7, 2022 14:41
kytrinyx and others added 24 commits September 19, 2022 11:32
Co-authored-by: ee7 <45465154+ee7@users.noreply.github.com>
Co-authored-by: ee7 <45465154+ee7@users.noreply.github.com>
Co-authored-by: ee7 <45465154+ee7@users.noreply.github.com>
Co-authored-by: ee7 <45465154+ee7@users.noreply.github.com>
Co-authored-by: ee7 <45465154+ee7@users.noreply.github.com>
Co-authored-by: ee7 <45465154+ee7@users.noreply.github.com>
Co-authored-by: ee7 <45465154+ee7@users.noreply.github.com>
Co-authored-by: ee7 <45465154+ee7@users.noreply.github.com>
Co-authored-by: Jeremy Walker <jez.walker@gmail.com>
Co-authored-by: Jeremy Walker <jez.walker@gmail.com>
Co-authored-by: Jeremy Walker <jez.walker@gmail.com>
Co-authored-by: Jeremy Walker <jez.walker@gmail.com>
Co-authored-by: Jeremy Walker <jez.walker@gmail.com>
Co-authored-by: Jeremy Walker <jez.walker@gmail.com>
Co-authored-by: Jeremy Walker <jez.walker@gmail.com>
Co-authored-by: Jeremy Walker <jez.walker@gmail.com>
Co-authored-by: Jeremy Walker <jez.walker@gmail.com>
Co-authored-by: Jeremy Walker <jez.walker@gmail.com>
Co-authored-by: Jeremy Walker <jez.walker@gmail.com>
People should go solve the first exercise in several tracks to get a feel for it.
@kytrinyx
Copy link
Member

Thanks for the comments, suggestions, and nitpicks, @junedev @ErikSchierboom @iHiD @ee7.

I'm going to squash and merge this, and then iterate further as the docs get read and we find more things to fix.

@kytrinyx kytrinyx merged commit ba3eba3 into main Sep 19, 2022
@kytrinyx kytrinyx deleted the syllabus-docs branch September 19, 2022 09:58
ErikSchierboom added a commit to ErikSchierboom/docs that referenced this pull request Nov 22, 2022
Draft introduction to syllabus design.

I'm trying to give enough background for people to be able to
think about syllabus design in a way that is useful and not
too overwhelming.

Co-authored-by: Erik Schierboom <erik_schierboom@hotmail.com>
Co-authored-by: ee7 <45465154+ee7@users.noreply.github.com>
Co-authored-by: Jeremy Walker <jez.walker@gmail.com>
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

Successfully merging this pull request may close these issues.

How-to Docs: Creating a syllabus
5 participants