search

pygame-community / pygame-ce

🐍🎮 pygame - Community Edition is a FOSS Python library for multimedia applications (like games). Built on top of the excellent SDL library.
https://pyga.me
941 stars 156 forks source link

Documentation Styling Modification #2233

Open Notenlish opened 1 year ago

Notenlish commented 1 year ago

Documentation Styling Modification

I think that the documentation styling that pygame-ce uses should be modified. Even though the dark theme addition made the documentation a little bit more modern, I still think that the documentation looks quite old. For some time @notmee12, @Sjmarf, @bilhox, me and more have been working on some mockups/generating ideas.

Modern Look

The documentation should be modern and easy to read. Currently it looks like this: image image

Accessibility

2224

Responsive

Currently the responsivity of the website especially for mobile devices is bad. image

Created Mockups

image image image image image

Figma link: pygame-ce documentation mockups Example documentation repo by @bilhox https://github.com/bilhox/pygame_website_example

@notmee12 also has a PR open currently to add a sidebar and make navigation easier in the documentation. https://github.com/pygame-community/pygame-ce/pull/2225

After this PR gets merged, a new pr should be opened to address this issue. Also related issue: #2227

NOTMEE12 commented 1 year ago

few new mockups: Zrzut ekranu (115) all of those are on figma page

I'm waiting to see which mockup we should use.

joereynolds commented 1 year ago

Chiming in as an outsider, I see no reason why we're writing our own themes when Sphinx has really good well-tested themes that we can pip install?

This one for example needs very few modifications to make it look "Pygamey". All we need to add is the ghastly green colour (which imo is also a major eyesore)

image

That being said, I do like the reorginsation of the content that you've put in. "Most useful stuff", "Advanced stuff" and "Other" are terrible headers with no value.

edit:

I had a play around with the "Insegel" theme which is found here and got promising results.

A bit of reorganisation of the content and maybe small hints of a nice shade of green would go a long way.

image

bilhox commented 1 year ago

Hello,

That's exactly what we want 😂, I don't know why I didn't look for other sphinx themes.

And yes, a bit of styling would be required so it looks more pygamey.

My website version is really similar to this one, I'll play a bit with the theme later.