It blows my mind that Rails Guides don’t have search built in. Sure I can use site:guides.rubyonrails.org in Google, DuckDuckGo, etc., but that’s a pain. And let’s face it, it’s a bit weird considering the guides are the friendly face of an infinitely flexible web app framework!

[image] scottmac: Is there any advantage of marking sections as in progress, given that all of the sections are constantly being updated? That mark is being used internally for guides that were never published neither reviewed by the documentation team. Those guides are incomplete or wrong, s…

I can see why for example the ActionText documentation is “Work In Progress” but I’m not sure why “Action View Overview” is still WIP. I’d like to help making it non-WIP.

It does seem silly I only go to rails guides for overviews and the occasional google result - but for every day I use Ruby on Rails - APIdock .

API Dock is not Rails official API documentation. The official docs are at https://api.rubyonrails.org/ . Docs for the next version at https://edgeapi.rubyonrails.org/ .

Right - that is exactly my point. Because it is well indexed and searchable, I rely on API Dock instead of the rails guides or API docs. In my ideal magical world, I would go to the official pages and they would all be well indexed, well integrated, and very searchable. And, ideally, commentable …

+100 could we please add a search and bring the useful stuff from APIdock, is painfully slow to search anything, but is the only good place we have now (unless we improve the oficial)

I would be happy to help set up DocSearch in rails guides! DocSearch: Search made for documentation [image] DocSearch: Search made for documentation | DocSearch by Algolia The easiest way to add search to your documentation - Powered by Algolia

Thanks @Spone . That was already proposed in the past, but we did not follow this route. The conversation is long, but there’s a summary here .

Thanks for not including algolia search. There is a trully open source alternative called Lunr.js https://lunrjs.com/ Should we consider that?

No search in Rails Guides

A May Of WTFs

amreez (Amree Zaid) May 9, 2020, 11:17pm 9

I love the commentable feature. It feels like PHP documentation in the old days. You’ll learn a lot just from the comments

Rails API Guides navigation

Topic		Replies	Views
Google custom search for guides.rubyonrails.org ? rubyonrails-docs	1	206	August 31, 2010
Can we change the ruby on rails website documentation? rubyonrails-docs	17	1456	July 26, 2022
Guides missing from index rubyonrails-docs	0	201	July 6, 2012
Searchable Rails API Docs? rubyonrails-talk	7	156	November 5, 2007
Rails API Documentation rubyonrails-talk	13	219	January 5, 2007

No search in Rails Guides

Related topics

More Resources