Rails Guides on the Kindle & Cover suggestions & Possible Logo use

rubyonrails-docs
1

Hi,

Firstly, I've forked docrails and have hacked it to compile a Kindle book from the rails guides:

https://s3.amazonaws.com/railsguides/guides.mobi

Apologies for pinching the 'railsguides' bucket name. I didn't know that it was a global thing - I might delete/move it shortly.

My fork, and the documentation for such, is at:

I'd like to refactor the changes in such a way that the fork can be re- integrated back in to the Rails Guides project and the Kindle version be made publicly available.

Some of the changes I've made will make it easier to port the Rails guides to other book-like formats. For example, I've moved the information from index.html.erb into a documents.yaml. A helper reads this file and is used to generate index.html and the Kindle table of contents.

Secondly, the Kindle guidelines strongly recommend a 600x800 cover image be provided with each document so that it shows up correctly when browsing. I'm at a bit of a loss as to what to do here.

One option, and the most obvious, would be a giant Rails logo with 'Rails $VERSION Guides' or similar placed under it. I understand that DHH has views on how the logo is used, so that may not be an option, and I am open to suggestions.

Regards, Michael Pearson

2

Thank you for your work on this, Michael. Much appreciated.

Rodrigo.

3

Guides for Kindle has been sent as a pull request: https://github.com/lifo/docrails/pull/73

It's a bit too big, I feel, for me to simply commit it without comment.

https://s3.amazonaws.com/railsguides/guides.mobi

has also been updated, as has

https://github.com/mipearson/docrails/blob/guides_for_kindle/railties/guides/KINDLE.md

4

Hi Michael, having the guides for the Kindle is awesome. Could you please send the pull request to Rails itself?

5

Hi Xavier,

Done! https://github.com/rails/rails/pull/3758