pygame-ce icon indicating copy to clipboard operation
pygame-ce copied to clipboard

Docs Rework

Open Notenlish opened this issue 4 months ago • 5 comments

Docs Rework

Pygame-ce documentation is old and has a bunch of legacy stuff and different formattings. This issue is meant to be a tracker to rewrite pygame-ce docs and have discussion about it.

General Issues

Old and outdated documentation styling. This PR aims to fix it: https://github.com/pygame-community/pygame-ce/pull/2924 Inconsistent Docs formatting: https://github.com/pygame-community/pygame-ce/issues/3130 Tutorials and convention : #1924

Suggestions

Adding User Guide

I believe we should replicate what https://docs.pola.rs/ has done, with the documentation being split into User Guide, API Reference and Development. That way we'll be able to accommodate both beginners, advanced users as well as contributors to pygame-ce.

Proper Code Structure

There are many old pygame tutorials available on the web, and this results in really poor code quality by newcomers. Not to mention that this also leads to a lot of issues when pygame-ce users use Pygbag to export their games. I believe a proper page for "pygame-ce approved" project structure is needed.

Performance Improvement

A lot of newcomers struggle with getting good performance while using pygame, there are common issues such as loading the same images every frame and drawing a lot of things using regular python loops. A dedicated performance page is a must in my opinion.

Pygame on Web

There should be more resources on how to avoid common issues and problems with pygbag. The majority of these should be in pygbag, however I believe it would make sense to at least include a special page/module in the docs for putting pygame games on the web.

Dedicated page for Blending Modes

There should be a dedicated documentation page or an interactive page in Pygame Community Website

Getting Rid of Obsolete Information

The current pygame docs has some old stuff from pygame 1.x. Stuff like New in pygame 1.9.5. could be removed. If we want to keep these information, we can store different versions of the wiki

Keeping Multiple Versions Of The Wiki

Self explanatory.

Notenlish avatar Sep 29 '24 12:09 Notenlish