search

envato / event_sourcery

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

Document the Public API of EventSourcery #143

Closed thekindofme closed 7 years ago

thekindofme commented 7 years ago

Context

We would like to have some basic YARD(http://yardoc.org/) style documentation for the ES API (ex: http://www.rubydoc.info/gems/hanami). To start out we'll be documenting the most used/important parts of the ES API.

The documentation will have to maintained when adding new features or changing existing behaviours.

Preview

http://www.rubydoc.info/github/envato/event_sourcery/4f99d8

joesustaric commented 7 years ago

@thekindofme we ok to merge this first version in?

thekindofme commented 7 years ago

@joesustaric yep I think we are good to merge this as is. I'll spring up another PR for the rest of the docs.

orien commented 7 years ago

Rendered here: http://www.rubydoc.info/github/envato/event_sourcery/4f99d8

orien commented 7 years ago

Excellent work guys. That's a lot of documenting.

twe4ked commented 7 years ago

Huge effort 👏