The api.rubyonrails.org site has a consistently quirky interface. It you go to the main site, you get this frames-based page with a nice search function on the side. But if you follow a link to anything in there, for example https://api.rubyonrails.org/classes/ActiveRecord/Persistence/ClassMethods.h…

It would also be really neat to have a panel to switch versions, kind of like Typescript and .NET’s docs have.

I want to add that this thread is the first time I’ve ever even seen the sidebar! I would love an easy version switcher as well.

This pull-request on SDoc removes frames in favor of a CSS solution on the guides :tada: : https://github.com/zzak/sdoc/pull/137/files

@sunfox That’s fantastic! This PR is almost a year old though. How can we boost its visibility?

I’ve pinged the original author, hopefully this can help to get it merged. Having more :+1:, reading and testing the code could also help this PR get some momentum.

I’ve updated the PR. There still are lot’s of things we can improve in later PR’s: I always find the top namespace pages confusing: ActionCable We could show methods in the sidepanel as well… We might collapse the linked files in the top bar…

While we’re documenting the API, could this become an official page, please? [taw] Which Ruby on Rails is compatible with which Ruby version? ruby-on-rails, ruby asked by taw on 09:19PM - 31 Jan 12 UTC One of my less-happy t…

Rails API Guides navigation

A May Of WTFs

Betsy_Haibel (Betsy Haibel) May 9, 2020, 2:07am 4

There’s some similar conversation going on in No search in Rails Guides - #9 by amreez if you want to join the party there!

Topic		Replies	Views
Api.rubyonrails.org versioning A May Of WTFs	14	2250	April 6, 2023
api.rubyonrails.org previous versions? rubyonrails-talk	7	1750	April 6, 2023
API and guides documenting an older version rubyonrails-core	1	207	December 2, 2011
Rails API difficult to use rubyonrails-docs	21	786	May 27, 2012
rake doc:rails template rubyonrails-core	5	253	July 13, 2012

Rails API Guides navigation

Related topics

More Resources