search

gbdev / pandocs

The single, most comprehensive Game Boy technical reference.
https://gbdev.io/pandocs/
Creative Commons Zero v1.0 Universal
617 stars 93 forks source link

Touch up SGB packet documentation #537

Closed ISSOtm closed 9 months ago

ISSOtm commented 10 months ago

Turn the diagram into a SVG, and reformat/improve the doc.

ISSOtm commented 10 months ago

Being that this is a SVG which automatically scales to the device width, there isn't really control over that. Compare Firefox's "Responsive" view simulating a phone screen:

Screenshot showing the diagram with a wildly different proportion

Is it a big deal?

avivace commented 10 months ago

I think shouldn't, check for example how https://gbdev.io/pandocs/Rendering.html#ppu-modes behaves, there is a limit on how "big it can become" while being free to get as small as possible preserving the layout when seen from smaller viewports..

ISSOtm commented 10 months ago

The same width limit applies to this diagram; though, perhaps what you're saying is that the proportions of the text versus the rest of the diagram are wrong? That I could fix.

Note that the PPU mode diagram becomes tiny on mobile screens, though; not that I believe anything can be done about that?

Screenshot of the aforementioned diagram rendered on a mobile screen

avivace commented 10 months ago

The same width limit applies to this diagram; though, perhaps what you're saying is that the proportions of the text versus the rest of the diagram are wrong? That I could fix.

Yep, I would say that should fix it

ISSOtm commented 10 months ago

Then you can try playing with the proportions by adjusting font-size in the SVG's embedded CSS. I find the current design fine, so I'll leave that tweaking up to you; I'd just like a chance to review that before merging?