search

envato / event_sourcery

A library for building event sourced applications in Ruby
MIT License
84 stars 10 forks source link

Document core concepts #37

Closed grassdog closed 8 years ago

grassdog commented 8 years ago

This is an attempt to start adding some documentation (in response to https://github.com/envato/event_sourcery/issues/19).

This starts out with documenting some core concepts. I'd love some feedback on verbiage and coverage.

/cc @stevehodgkiss @vonconrad

grassdog commented 8 years ago

I'd like to add more code examples inline as well as the APIs stabilise.

stevehodgkiss commented 8 years ago

Looks good! 👍

vonconrad commented 8 years ago

Good start. I agree that inline docs once the API settles is a good idea as well.

👍

thekindofme commented 8 years ago

Very helpful when you are new to the project

💯 👍

grassdog commented 8 years ago

Hey @stevehodgkiss and @vonconrad I've pushed up a few more commits fleshing things out further. I think this is probably ready to merge. Let me know if you think it needs any more changes.

I'm thinking a separate document for getting started with more code examples makes sense. It can be more focussed towards the code users actually need to write while this document can focus on giving overall context.

stevehodgkiss commented 8 years ago

Nice one... I like the application-tour diagram 👍

orien commented 8 years ago

👍 As a newbie, this helps me. Thanks.