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

Discussion related to the tutorials section #11

Open
ScriptLineStudios opened this issue Feb 19, 2023 · 4 comments
Open

Discussion related to the tutorials section #11

ScriptLineStudios opened this issue Feb 19, 2023 · 4 comments
Labels
Impact.Medium This will have a moderate-level change/impact on the codebase Priority.Medium This is interesting and worth tackling when the chance arises Type.Enhancement Improvements to existing features

Comments

@ScriptLineStudios
Copy link
Member

we can definitely work from here - https://www.pygame.org/wiki/tutorials although it would also be nice to write out own tutorials. Maybe we could write a mini tutorial series which takes you from start to finish building a simple game

@novialriptide
Copy link
Member

novialriptide commented Feb 20, 2023

I'm all for a written tutorial series. We might have them as Markdown files and compile them into HTML files later so anyone can contribute easily.

To add some fun cosmetics, we can add a footer that contains all of the contributors who have edited the tutorial and order them by the number of lines/commits added/removed. I want to do this for the new documentation as well.

@itzpr3d4t0r
Copy link
Member

Would be cool to have some way to run the example code in the web.

@novialriptide
Copy link
Member

Would be cool to have some way to run the example code in the web.

Yup! That's the plan for the far future. (Probably during the summer break when I don't have discrete math killing my GPA)

@novialriptide novialriptide changed the title Tutorials Discussion related to the tutorials section Feb 20, 2023
@Mega-JC Mega-JC added Priority.Medium This is interesting and worth tackling when the chance arises Type.Enhancement Improvements to existing features Impact.Medium This will have a moderate-level change/impact on the codebase and removed Impact: Medium 💦 labels Feb 23, 2023
@simplyrohan
Copy link

For a while now, I've been thinking of a complete rewrite of the documentation, but with an approach similar to Flask. What I mean by this is that Flask teaches their documentation through the project flaskr. This is actually really helpful because it shows not only the technicalities but usage as well. By that point, tutorials could just smoothly walk right in. Still developing a game, tutorials could further push the "usage" docs by implementing higher-level concepts like physics. Another benefit of this approach is that instead of teaching concepts on their own, this also shows how to integrate features together to make a fully functional game. Finally, this type of teaching also could work excellently as a reference and not just a follow-along, baby-steps tutorial. My main point here is that documentation and tutorials could be integrated smoothly with a project to work on (I'm thinking of a platformer).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Impact.Medium This will have a moderate-level change/impact on the codebase Priority.Medium This is interesting and worth tackling when the chance arises Type.Enhancement Improvements to existing features
Projects
None yet
Development

No branches or pull requests

5 participants