Skip to content

Documentation Styling Modification #2233

@Notenlish

Description

@Notenlish
Contributor

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. #2225

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

Activity

NOTMEE12

NOTMEE12 commented on Jun 26, 2023

@NOTMEE12

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

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

joereynolds

joereynolds commented on Oct 5, 2023

@joereynolds

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

bilhox commented on Oct 5, 2023

@bilhox
Contributor

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

      Development

      No branches or pull requests

        Participants

        @joereynolds@Starbuck5@bilhox@Notenlish@NOTMEE12

        Issue actions

          Documentation Styling Modification · Issue #2233 · pygame-community/pygame-ce