trailblazer / cells

View components for Ruby and Rails.
https://trailblazer.to/2.1/docs/cells.html
3.07k stars 236 forks source link

Documentation is difficult to get up and running with #345

Closed adsteel closed 9 years ago

adsteel commented 9 years ago

Based on the current readme, it took me a lot of guesswork and calls to binding.pry to make a very basic Cells implementation in my current app. As is, I may hit a timeout on the concept before I have a chance to really build a good example to bring to my colleagues. If I figure it all out, I may have capacity to improve the readme myself, but I wanted to log this issue in case anyone else has ideas.

apotonick commented 9 years ago

Are you confusing Cell::ViewModel and Cell::Concept? The documentation clearly distinguishes between them. Note that all documentation is getting moved here http://trailblazer.to/gems/cells/ and to the books, but you're more than welcome to help improving it.

apotonick commented 9 years ago

And join the Gitter channel if you need help. I will add Getting Started tutorials for every Trailblazer gem in a few weeks but in the meantime, come chat with us.