Stream: contributing

Topic: docs


view this post on Zulip Anton (Dec 30 2024 at 15:29):

I think we should widen the central docs column and use the same font size for all code. At the moment the code example box is only 63 chars wide. Tagging @Anthony Bullard for thoughts
Screenshot from 2024-12-30 16-23-41.png

view this post on Zulip Anthony Bullard (Dec 30 2024 at 16:18):

How about 70ch wide (like the tutorial), and both using 14pt(this is for A11y, otherwise I need to adjust the saturation more which makes things look undifferentiated)?

view this post on Zulip Anton (Dec 30 2024 at 16:46):

Screenshot from 2024-12-30 17-46-20.png
I think the tutorial's width is still too narrow

view this post on Zulip Anton (Dec 30 2024 at 17:20):

python's sacred 80 could be nice

view this post on Zulip Anthony Bullard (Dec 30 2024 at 17:29):

I’m not totally opposed but for text comprehensibility declines at around 70

view this post on Zulip Anthony Bullard (Dec 30 2024 at 17:29):

I kind of would like to explore making the code examples more full bleed

view this post on Zulip Richard Feldman (Dec 30 2024 at 17:30):

I'm more concerned about font size on the tutorial

view this post on Zulip Richard Feldman (Dec 30 2024 at 17:30):

I wouldn't want to make the font size smaller just to make more things fit horizontally

view this post on Zulip Anton (Dec 30 2024 at 17:31):

I agree

view this post on Zulip Richard Feldman (Dec 30 2024 at 17:31):

I think mobile will actually be the bigger constraint

view this post on Zulip Richard Feldman (Dec 30 2024 at 17:31):

than desktop

view this post on Zulip Anton (Dec 30 2024 at 17:31):

Anthony Bullard said:

I kind of would like to explore making the code examples more full bleed

That sounds good!

view this post on Zulip Richard Feldman (Dec 30 2024 at 17:31):

or rather, the narrower constraint :big_smile:

view this post on Zulip Anton (Dec 30 2024 at 17:32):

Richard Feldman said:

I think mobile will actually be the bigger constraint

What's the takeaway here?

view this post on Zulip Anton (Dec 30 2024 at 17:33):

It seems like we should not make the code boxes narrow on desktop because they're narrow on mobile

view this post on Zulip Richard Feldman (Dec 30 2024 at 17:35):

oh I agree

view this post on Zulip Richard Feldman (Dec 30 2024 at 17:35):

just something to keep in mind that we have to deal with :big_smile:

view this post on Zulip Richard Feldman (Dec 30 2024 at 17:35):

code snippets on mobile are sort of inherently annoying

view this post on Zulip Anthony Bullard (Dec 30 2024 at 17:37):

Mobile should be usable for a quick lookup, but desktop is what should be optimized

view this post on Zulip Anthony Bullard (Dec 30 2024 at 17:37):

I rarely code Roc on my iPhone

view this post on Zulip Richard Feldman (Dec 30 2024 at 17:41):

people do read tutorials on phones though

view this post on Zulip Richard Feldman (Dec 30 2024 at 17:41):

e.g. if they see Roc on Hacker News on their phone, and follow the link to start learning about it

view this post on Zulip Georges Boris (Dec 30 2024 at 17:42):

One idea would be to make the text be optimized for line breaks (~60rem) and make the code blocks be full width.

But for that to look good we should probably align the column to the left so the full width code looks like it would on an editor.

view this post on Zulip Georges Boris (Dec 30 2024 at 17:43):

That would also make it easier for adding extra content to the right (like secondary navigation, notes, or whatever... if we ever come to that)


Last updated: Jul 05 2025 at 12:14 UTC