Add support for mobile screen sizes on Darkfish #1025
Conversation
MatheusRich
force-pushed
the
mr/mobile-docs
branch
from
9b4893d to
d88b2a0
Compare
|
Thank you, seems very nice. |
@nobu, I totally missed that it is resizable! Would it be a problem if we make it fixed-sized? I think that would be a small sacrifice for a simpler solution. Edit: I made the sidebar fixed-sized. |
|
@nobu could you approve the workflow so we can see if this works on CI? Thank you! |
|
It looks like the tests breaking here are the same as the ones in the main branch. |
MatheusRich
force-pushed
the
mr/mobile-docs
branch
from
f8345cc to
aad7d9e
Compare
|
Sorry to ping you again, @nobu. Can we get a second look at this? |
|
@peterzhu2118 can you take a look at this? |
This adds support for reading the Darkfish-generated docs in mobile devices. I tried to keep the changes minimal, and the current layout was mostly preserved. The most notable change is the navigation sidebar, which is now hidden by default on "small screens" (everything below 1024px). It can be toggled by the button on the top left corner. This button implements the ARIA pattern for a [disclosure widget]. The icon for the button was taken from [Iconoir], which is licensed under the MIT license. The design and some of the implementation were loosely inspired by the [Elixir lang docs]. [disclosure widget]: https://www.w3.org/WAI/ARIA/apg/patterns/disclosure/ [Iconoir]: https://iconoir.com/ [Elixir docs]: https://hexdocs.pm/elixir/1.15.2/Kernel.html
|
@hsbt any plans on merging this (or not)? |
|
I have no opinion that. @nobu How about your opinion? |
|
@colby-swandale LMK if you have any thoughts on this |
There was a problem hiding this comment.
Since RDoc's own documentation ruby.github.io/rdoc/ is built with the latest RDoc, I think we can merge this PR and see how these changes play out.
|
Is this behaving as intended? On desktop (macbook air M2, seems to be the same in firefox, safari, and chrome) I get a sidebar open by default covering a large portion of the page (but also not the full page height)
|
|
@jhawthorn there's an open PR to fix that already |
This adds support for reading the Darkfish-generated docs in mobile devices. I tried to keep the changes minimal, and the current layout was mostly preserved.
The most notable change is the navigation sidebar, which is now hidden by default on "small screens" (everything below 1024px). It can be toggled by the button on the top left corner. This button implements the ARIA pattern for a disclosure widget.
The icon for the button was taken from Iconoir, which is licensed under the MIT license.The design and some of the implementation were loosely inspired by the Elixir lang docs.
Screenshots
General look (before/after)
Code blocks (before/after)
Desktop view (before/after)
The most notable change here is that I limited the content size to about 1000px. Long lines are hard to read, so I added this little quality-of-life improvement for desktop users.
The sidebar can also be closed on desktop:
Video
Screen.Recording.2023-07-05.at.19.59.33.mov
Testing
I wasn't sure if this change required tests. LMK if I need to add them.