Recent searches
Search options
This has bothered me for years: You open the Rails API documentation, click on ActiveRecord in the sidebar ... and you are basically lost....
You see a lot of namespaces with no idea what to do next.
Pretty excited to get this one working: Including the READMEs
for the main Rails framework API pages.
https://github.com/rails/rails/pull/47717
Thanks to @zzak for the `:include:` directive tip.
@p8 I saw your message about SEO of this doc. Don't you think that Rails Foundation could pay a company that will work on that?
Also I recently read this and think we could also grab some ideas. https://twitter.com/DevanilJr/status/1636479080269791233?t=T9-4nH0V8vx_-CGzASLu8A&s=09
@benoit Personally I'd rather have them spend money on things the community isn't doing right now. ApiDock currently has a single page per method which allows better SEO scores as the <title> and <h1> both mention them methods.
Any ideas specifically you think we could grab from those React docs?
@p8 Maybe more videos. Or something with more visual output. The Rails intro guide is good but pretty big.
@benoit I think that is the plan...
@p8 I think we need more "wahoo" effect. Like you can sometimes have with Stimulus. For example https://twitter.com/ilrock__/status/1631315562390519809
@p8 @zzak ok i love this change!
@p8 about the file list:
I would keep them where they are but put them in a <details/> so you can expand it if you wanted. The summary could be something like “In X files”, and if it’s only one file, just put it there and skip the <details/>.
https://developer.mozilla.org/en-US/docs/Web/HTML/Element/summary
That is nice! Thanks for the tip @ZiggyTheHamster !