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

are tutorial code simple enough? #32

Open
esaule opened this issue Jul 27, 2019 · 3 comments
Open

are tutorial code simple enough? #32

esaule opened this issue Jul 27, 2019 · 3 comments
Assignees

Comments

@esaule
Copy link
Member

esaule commented Jul 27, 2019

We talked about shrinking the size of the tutorial codes to really give an idea of the usage but without making the codes too long to avoid scaring the users.
Are the codes short/simple enough?

I am guessing not:
file:///home/erik/work/bridges/BridgesUNCC.github.io/tutorials/Graph_AL.html

I am wondering whether they should be straight to the point, just like what the snippet for the data sources are.

Maybe we can keep a second longer example, but maybe have a first one that is very simple?

@esaule
Copy link
Member Author

esaule commented Jul 27, 2019

I just added @AlecGoncharow as an assignee to get his opinion since he talked to a bunch of people at sigcse who had mentionned the tutorial were too complicated. Thoguht he'd have an opinion on the question.

@AlecGoncharow
Copy link
Contributor

Looking at the graph code it seems we may be overwhelming people with too complex of a graph while also dipping into the data source dependent stuff. I'd recommend having a KISS example for each class/module and then having an example like the bacon number graph as an example separate from the tutorials.
Ultimately we probably would want a barebones example for each tutorial, that way people can see the usage for each class without worrying about understanding styling logic and such.
Basically strip away the bells and whistles and just show a default graph with examples of how to add edges and such. Same could go for the linked list stuff and the arbitrary student class.

@esaule
Copy link
Member Author

esaule commented Jul 20, 2022

We've done some of that.

I suggest that we review all our existing tutorials and put explicite notes of which ones should be broken down.

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

3 participants