Using GitHub for tutorials (image, BOM, text, code) for students to comment, branch, etc.

Dear GitHub community,

before I go down the wrong route, I’d like to find out, if GitHub’s functionality is right for what I want to do.

I have created a repository and the required readme file. Within that repository, I want to add a number of individual physical computing projects, about 10 for starters, later more. Each project should have one descriptive photograph, one diagram, one list (a BOM), one short descriptive text and, of course, one extensive code example. Students should be able to comment on the code and, of course, create their own versions.

Is GitHub a good solution for that? How would I house all projects inside the repository? How could I create a non-code page (image, BOM, text) for each project in that repository? Or would I need a repository for each project? Or is GitHub not the appropriate solution for my use case?

Any input very much appreciated!

Hi systembolaget,

 

This post was moved to a different board that fits your topic of discussion a bit better. This means you’ll get better engagement on your post, and it keeps our Community organized so users can more easily find information.

 

As you’ll notice, your Topic is now in the Project Development Help and Advice board.

 

Let me know if you have any other questions or if I can help with anything else.

 

Cheers!

Andrea

You could definitely use GitHub for that kind of thing. I would probably recommend a repository for each project, but you could also store all projects in one repository with a subdirectory for each project in the repo. Comments on the code can be done through issues and students could make their own copies of the projects by using the fork function of GitHub that they can then modify to their hearts’ content. Most people use Markdown for creating documentation or non-code pages within a repository.

I hope that helps!