search

franzejr / best-ruby

Ruby Tricks, Idiomatic Ruby, Refactoring and Best Practices
http://franzejr.github.io/best-ruby/
2.39k stars 218 forks source link

convert to Gitbook #8

Closed antulik closed 8 years ago

antulik commented 9 years ago

This is suggestion to convert this repo into gitbook (https://www.gitbook.com/)

Once converted it will be easier to browse and can be published as webpage. For example http://developer.gitbook.com/index.html

kikihakiem commented 9 years ago

I second that

franzejr commented 9 years ago

This is definitely a great idea. But for starting this, I think we should start adding some categories to the tricks we have so far. What do you think?

antulik commented 9 years ago

@franzejr i agree, would be good to group things so it's easier to follow. In addition since most of examples are only few lines of code I see no reason to keep one example per file. We could have multiple examples on the single markdown page.

franzejr commented 9 years ago

@antulik look at the current version of the readme. Now, all the tricks are listed in the same markdown file.

franzejr commented 9 years ago

@antulik, I just checked GitBooks. Definitely it's a good way for creating a book. I'm not sure if it's worth right now, since the README we have is pretty straightforward .

antulik commented 8 years ago

@franzejr it's much more readable right now. Have few small concerns about all those *.rb files in the repo, what's their purpose?

Single markdown is easy to read and search but hard to make sense of once it's too big. For example if we group example by cagetory (e.g. Array) then it would be easier follow example since they all would talk about Array.

There are already 39 examples, it's impossible to quickly read titles (only titles) of all of them. Considering the collection will grow it will be even more harder. But if we group those 39 examples into ~7 groups it will be easier to navigate overall.

franzejr commented 8 years ago

@antulik, good to hear! Related to the ruby files, one thing just came up in my mind: Put all the .rb files in a folder, for instance, /tricks, with this, it's not necessary scroll down too much for seeing the README itself.

Related to the categories, I think we may start using some categories, such as: https://youtu.be/aBgnlBoIkVM?t=2m29s

franzejr commented 8 years ago

@antulik, I think we can move this discussion for other issue regarding to categories.