Improve AggregateRoot docs - Githubissues

RailsEventStore / rails_event_store

A Ruby implementation of an Event Store based on Active Record

http://railseventstore.org

MIT License

1.42k stars 121 forks source link

Improve AggregateRoot docs #980

Open mostlyobvious opened 3 years ago

mostlyobvious commented 3 years ago

one of most popular docs pages
does not depict current recommendations for AggregateRoot best practices
needs some background on why
link to arkency/aggregates and other newer resources
dissect event sourcing steps

tomaszwro commented 3 years ago

Some things to be improved:

on instead of apply_
helper with_aggregate_root instead of default_event_store; see https://github.com/RailsEventStore/cqrs-es-sample-with-res/blob/master/lib/command_handler.rb
with_strategy instead of apply_strategy see https://github.com/RailsEventStore/rails_event_store/blob/master/aggregate_root/lib/aggregate_root.rb#L74-L85
examples from cqrs-es-sample-with-res can be used in docs

tomaszwro commented 3 years ago

things to mention explicitly:

no side effects in handlers
two types of methods

tomaszwro commented 3 years ago

doc page in question: https://railseventstore.org/docs/v2/app/

mostlyobvious commented 2 years ago

testing event sourced aggregates (as discussed in https://github.com/RailsEventStore/rails_event_store/discussions/1345)

mostlyobvious commented 2 years ago

examples from cqrs-es-sample-with-res can be used in docs

this is now https://github.com/RailsEventStore/ecommerce