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

Make content more readable #2944

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

Blargian
Copy link
Member

@Blargian Blargian commented Dec 22, 2024

Summary

Introduces a small styling change to content width to improve readability. Closes #2940. Currently docs have the Docusaurus content area defaults overridden to make content full page width. This results in a high character count per line compared to other documentation sites (see eg. React Native, Jest, MongoDB) and general guidelines for readability (see #2940 for justification).

Before:
image

After:
image

Small change but makes a huge difference to readability in my opinion. We can always increase padding between content and the table of contents on the right if the white space on the right feels uncomfortable.

Of course subjective, interested to know what others think.

Checklist

@gingerwizard
Copy link
Contributor

@gjones your opinion here please

@gingerwizard
Copy link
Contributor

@Blargian we defer this to design. cc @gjones who has to approve visual changes.

@Blargian
Copy link
Member Author

Blargian commented Jan 2, 2025

Actually, docs site looks quite okay on a smaller screen. I think all that's needed here is a media query for devices with wider screens (eg 2560x1600 was what I was using when I made the issue)

@gjones
Copy link
Contributor

gjones commented Jan 6, 2025

@Blargian Thanks for doing this! I'd rather we avoided centring the content though as it introduces an awkward gap between the navigation and the documentation. I do agree that the width needs to be limited though. I'd vote we keep it simple and just a max-width: 1024px (or larger) to the docItemContainer_c0TR which would give us something like below. Would that work for you?

CleanShot 2025-01-06 at 13 25 24@2x

@Blargian
Copy link
Member Author

Blargian commented Jan 7, 2025

@Blargian Thanks for doing this! I'd rather we avoided centring the content though as it introduces an awkward gap between the navigation and the documentation. I do agree that the width needs to be limited though. I'd vote we keep it simple and just a max-width: 1024px (or larger) to the docItemContainer_c0TR which would give us something like below. Would that work for you?

CleanShot 2025-01-06 at 13 25 24@2x

That works too!

@Blargian Blargian added the P3 label Jan 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve readability of documentation
3 participants