6 ms·
Ruby's official documentation just got a new look
- strzibny 2y agoOh no, much prefered the old look. And why the hell green? Ruby's not Python :(
- pyinstallwoes 2y agoYeah that’s weird
- yumraj 2y ago> Ruby's not Python :( You mean Ruby's not Emerald ;)
- pentestercrab 2y agoI have to agree with you. It is a shame the classic style isn’t available at an alternate subdomain or directory. Has anyone tried rendering the current docs with the old theme?
- stevenfoster 2y agoBig nope.
- 3np 2y agoTwo regressions I noted right away (chromium): - CPU usage and rendering overhead/waiting time is noticably higher than on the old version. - The supposedly responsive functionality means that the sidebar hides ~half of main content on my default window size and resolution on desktop. I have to zoom out to be able to read at all.
- retrac98 2y agoThis either hasn’t been tested on a mobile device or the developer decided mobile devices weren’t important enough to properly support at launch. Bad look either way.
- zarzavat 2y agoIt feels unfinished. It doesn’t work very well on mobile. Though, I’m not sure that the old one did either. There’s too much white space. Documentation should be compact so that you can fit as much as possible on the screen while remaining legible. The colour.
- thiht 2y agoI can’t believe a mostly text website that doesn’t scale well on mobile made it to production in this day and age. Was it worked on by a single person? Did no one review it and think of opening it on their mobile? I’d even say it’s harder to make a text website NOT render well on mobile. Doesn’t HTML handle that by default, unless you use some freakishly long text without spaces?
- phoronixrly 2y agoNot every website's key metric is conversion of mobile users. I have never needed to read Ruby documentation on my phone. I'm glad they did not waste their time on unimportant stuff like mobile UX in this case.
- thiht 2y agoI doubt you’re the only user of the Ruby documentation though. I’m not a (frequent) Ruby user, but I routinely check the Go documentation, the MDN, the Python documentation, and several other language documentations on mobile. Because sometimes I will think of something while I’m walking my dog, or while I’m in my couch, or before sleeping, or at any other moment. Mobile UX is exactly as important as desktop UX. And for a text only website (ie. not a web app) you don’t even need to spend time to make it work, it’s almost the default behavior. You have to go out of your way to make a text website that doesn’t render well on mobile.
- oefrha 2y agoWaste time? I can make a one line change to make it basically good enough on mobile: - main { max-width: 800px; } + main { box-sizing: border-box; max-width: min(864px, 100%); } There. Anyone who thinks that's a waste of time probably shouldn't be allowed to touch the CSS of a high traffic website.
- underwater_sky 2y ago[flagged]
- porgarmer 2y ago- Why is this dark green? - Its very hard to navigate around and easy to get lost with links. - Mobile view is borderline unusable. Need to scroll horizontally to read a sentence. - Cursor is a beam while hovering over the sandwich menu icon
- baggy_trough 2y agoThat's nice, but what I'd like is if I type the name of a major class, like "File", that the File class be on top, not some obscure method/module that contains "File" as a substring.
- ilikepi 2y agoThe search issue is also present with the docs for Ruby 3.3[1] and earlier. Incidentally, "String" is an even better example, as the the class is the fifth result returned after four other very obscure classes. [1]: https://docs.ruby-lang.org/en/3.3/ https://docs.ruby-lang.org/en/3.3/
- baggy_trough 2y agoI'd love to know where that ordering comes from. Insanity!
- jspash 2y agoAccessibility-wise it has problems. Font-size, colour, contrast to name a few. And overuse of bold. When everything has emphasis, nothing does. And green? How did that get approved? I'm glad things are still moving in the Ruby community. I use it every day. But Elixir is winning the mind-share battle over Ruby at $dayjob these days. And their documents is second to none. One of the best that I've used.
- dudeinjapan 2y agoThe main font color for Ruby is... green?
- ilikepi 2y agoThis seems to be a reskin of the prior RDoc styles, which are visible in prior Ruby versions (e.g https://docs.ruby-lang.org/en/3.3/ https://docs.ruby-lang.org/en/3.3/). Despite the rather bold green, the overall look of the primary content feels very subdued. I think a big part of it is how low-contrast the code blocks are. In the prior style, code blocks used a pretty high-contrast syntax highlighting scheme; comments were very distinct, which is important as these demonstrate return values. In the new style, it's quite difficult to distinguish comments (medium gray) from identifiers (dark gray). Personally I prefer the look of rubyapi.org over either of the official ones, but this new one kinda feels like a step backward from the prior one.
- rootedbox 2y agoDoesn’t work on mobile - sent from my iPhone
- wiseowise 2y agoNot optimized for mobile in 2024, seriously?
- marginalia_nu 2y agoGiven how technical documentation is typically used, when would you view it on a mobile device?
- orhmeh09 2y agoExtremely often. I look at source code, API docs, issues, etc. on my phone all the time when I am on the bus or in the bathroom or in bed or wherever.
- jimworm 2y agoI wouldn't mind if ruby copied the rails docs style exactly (https://api.rubyonrails.org/ https://api.rubyonrails.org/), and I'm pretty sure rails wouldn't mind either.
- thiht 2y agohttps://api.rubyonrails.org/classes/ActiveJob.html https://api.rubyonrails.org/classes/ActiveJob.html That one's a bit too much red for my taste :) There's a sweet spot to find that's closer to "nice accent colors" than "aggressive red wall of text"
- james_marks 2y agoThe challenge is that if you only sprinkle some red in for accents, the accents look even more like an error. It’s a conundrum.
- felipemesquita 2y agoThe rails api docs are also going through a redesign, you can see a preview of the next design in edge: https://edgeapi.rubyonrails.org/classes/ActiveJob.html https://edgeapi.rubyonrails.org/classes/ActiveJob.html I think it’s a a change in the right direction that removes the “aggressive wall of text” on longer pages and looks great in dark and light modes.
- tapanih 2y agoI like the new code blocks more! The syntax highlighting is more standard. I found the red comments on a grey background difficult to read in the old theme. However, I would still want to see higher contrast in the text. It looks like the mobile view is getting fixed [1]. [1] https://github.com/ruby/rdoc/pull/1162 https://github.com/ruby/rdoc/pull/1162
- biql 2y agoSadly, the typography looks too neglected for the time when there is such an abundance of templates and fonts.
- lawgimenez 2y agoThe font is not good for my bad eyesight with severe astigmatism.
- Archelaos 2y agoIt is generally hard to read, even with only mild astigmatism and perfect glasses. What is even worth is that the Website does not appear to support Firefox's readability mode. That seems to be the curse of our time: Function follows form.
- Corrado 2y agoI use Firefox's readability mode for quite a lot to help me process these "pretty" web pages. Most of the time it works pretty well and I can read the content even faster. Even if it doesn't work perfectly, it still provides a better contrast than the original. In the case of these new Ruby docs, it falls apart more completely than I've ever seen. It's completely unusable! As a terrible Ruby programmer with pretty good 55 year old eyes I can't read these docs at all. Everyone is complaining about the color scheme (which I agree with) but its the font choices (lightweight, grey on grey) that kills usability for me. When I'm looking at docs I need to find what I need quickly, and searching a sea of whitespace and barely there text is not great.
- aa_is_op 2y agoIt's called Ruby, but the color theme is green. Hilarious!
- Themainfn 2y agothe font looks stuck at 99%
- nomilk 2y agoLots of (justified) negative observations. But I love the way the code looks (which, by far, is the most important thing for documentation of code). Random example: https://docs.ruby-lang.org/en/master/ARGF.html#method-i-each https://docs.ruby-lang.org/en/master/ARGF.html#method-i-each Love the new colour scheme, easy to read (on desktop) and feels more chill than reds and greys.
- pilaf 2y agoWould be nice if the hidden by default C code was syntax-highlighted as well.
- troupo 2y ago> Love the new colour scheme, easy to read (on desktop) and feels more chill than reds and greys. The main font is very thin light gray font to begin with that makes it very hard to read even on a 4k monitor
- bachmeier 2y ago> Ruby is an interpreted object-oriented programming language often used for web development. Talk about irony. I increased the font to 150% so I could read that very sentence, and it's literally impossible to do so, because the sidebar covers the text when you zoom in that far. And the only reason I zoomed in that far was because they used Lato-light rather than Lato-regular. Maybe Ruby isn't used for accessible web development.
- pilaf 2y ago> Maybe Ruby isn't used for accessible web development. What an unnecessary comment. Sure, the docs website could use more work, but what does the choice of a language used for back-end development have to do with the quality of the front-end code (non-Ruby) in those same projects?
- bachmeier 2y ago> What an unnecessary comment. It's 2024. Accessibility is absolutely worthy of comment, particularly if you're boasting about being a language used for web development. They could have used one of the thousands of available existing solutions rather than rolling their own. > a language used for back-end development have to do with the quality of the front-end code (non-Ruby) Ruby is used for a more than the back-end. Check out Sinatra or Rails.
- paradox460 2y agoSinatra and rails both run on the backend
- vinc 2y agoIf I change the color hue of all the CSS variables from green to red, and make the text a bit darker and larger it's not so bad. With a light gray background on the sidebar to provide some contrast with the main content like the Rust doc does I quite like it. I'll probably create custom CSS rules for the doc if this is the final version and be happy with it. I've been using a custom dark theme for HN for years and I'm happy with it. I'm glad we still have enough control over web pages to do that!
- blahgeek 2y agoWhat we really need is a common downloadable documentation format so that we can more easily build tools to read documentation of all languages and libraries in one place with unified interface, instead of jumping between tens of browser tabs each with a different (new) look. I know there is devdocs [1], but unfortunately it need to implement scrapers and filters for each site specifically. [1] https://devdocs.io/ https://devdocs.io/
- mkl95 2y agoI remember this kind of UX being prevalent in the early 2010s or so. Fortunately most docs have moved on.
- Taig 2y agoThere is a lot wrong here. But my favorite messed up detail is how my cursor changes to text mode when I hover the hamburger button on the top left.
- thiht 2y agoThe cursor also switches to "pointer" (the hand) for no reason on the documentation pages, eg. here: https://docs.ruby-lang.org/en/master/String.html#method-i-rindex https://docs.ruby-lang.org/en/master/String.html#method-i-ri...
- Alifatisk 2y agoSo what alternatives is there to the official docs? ruby-docs.org is sadly gone https://web.archive.org/web/20230615061406/https://www.ruby-docs.org https://web.archive.org/web/20230615061406/https://www.ruby-... There is https://rubyapi.org https://rubyapi.org and https://ruby-doc.org https://ruby-doc.org left from what I know
- pawelduda 2y agoDon't like it, don't know what problems it was supposed to solve
- nilslindemann 2y ago* Ugly font rendering * Underscores in page names * No 'next' and 'prev' buttons. When that is done it should be a good start.
- rob 2y agoNothing like making green the primary color on your "Ruby" website and spending zero minutes checking it on mobile to notice that every page horizontally scrolls.
- johnisgood 2y agoYeah, odd choice of colors.
- matteason 2y agoIs the font rendering any better on other platforms? On Windows it's so poorly hinted that the top and bottom of the lowercase 's' are disconnected
- ntlrkq 2y ago[flagged]
- jacamera 2y agoNo dark mode? Seriously?
- InMice 2y agoDarkreader plugin to the rescue
- elif 2y agoThis reminds me of all the times a manager asked if I (backend dev) could 'just do a little interface for xyz' Like what do you expect from me? I would be rendering these docs in a w3 emacs frame...
- jeremymcanally 2y agoThere are a lot of odd choices here. Is there a mailing list thread or something where this was worked out? I couldn't seem to find one on a quick scan, but I don't know where these discussions happen these days. I really don't want to assume incompetence or ignorance at all since I'm sure someone worked really hard on this. But I'm genuinely puzzled by a lot of what's going on.
- tomstuart 2y agoHere’s the PR. I don’t know whether it was discussed elsewhere. https://github.com/ruby/rdoc/pull/1157 https://github.com/ruby/rdoc/pull/1157
- alabhyajindal 2y agoLooks terrible. Very sad.
- deleted 2y ago[deleted]
- cute_boi 2y agoThey should probably get idea from Laravel docs.
- deleted 2y ago[deleted]
- usernamed7 2y agoWhy is it green? It shouldn't be green. Ruby docs should be red. If i stumbled onto this site while looking for docs about a ruby method, i'd think I landed on the docs for some other programming language or fork of ruby. That's how off-brand this is - to the point of being disorienting as a user. There are not a lot of things that create a brand around a programming language, and color is definitely one of them. This is such a tasteless design decision for something meant to be official ruby documentation that I can't even appreciate any other changes that docs may introduce. And then the fact that it doesn't even work on mobile... I am truly baffled anyone would think this is in good taste. the last time I saw such a fumble with ruby related docs was back around 2014 when relishapp was the only place to get rspec docs. It's UX was such a painful mess that i just avoided it at all costs. Glad to see it's dead now.
- pmdr 2y agoNot the best redesign, but probably the most upvotes and comments on a Ruby related post lately, so yay?
- yunwal 2y agoUp there with Tropicana and Gap for senseless rebrands
- ameliaquining 2y agoTo everyone commenting about it being green: This isn't a new change, it's always been like that. https://web.archive.org/web/20141203122328/http://docs.ruby-lang.org/en/trunk/ https://web.archive.org/web/20141203122328/http://docs.ruby-... If you thought it used to be red, you are probably thinking either of ruby-doc.org, which is an unofficial third-party site (but is older than docs.ruby-lang.org), or of the Rails docs.
- flufluflufluffy 2y agoThe vomit-green color is my favorite part. Like, they didn’t even try for a forest-green, or lime-green, nope. went straight for vomit
- majewsky 2y agoHere's a user stylesheet to make it slightly more readable: #root { color: black; } main { color: var(--text-color); } Regular reminder to all designers that not everyone uses an Apple 50K Retina Ultra Whatever Display in a professionally lit studio apartment.
- oglop 2y agoPeople not in the Ruby unity probably don’t realize Ruby takes a very liberal approach to its docs. Most people just use rubyapi.org because it’s modern and looks good. It’s backed by the Ruby foundation. These docs are just the “official docs” which I almost never even use anyways. Glad they don’t look like they’re from 2001 anymore but I’m likely to keep using rubyapi.org as it’s just way out ahead in looks and mobile support.