serverlesstechnology / cqrs

A lightweight, opinionated CQRS and event sourcing framework.
Other
382 stars 40 forks source link

Documentation and Demo mismatch #99

Closed lambdalisue closed 3 weeks ago

lambdalisue commented 1 month ago

There were many parts in the documentation that lacked information such as 'which file to write in' or a complete implementation of each section, so I was reading it while referring to the demo simultaneously. However, upon reaching the chapter on application implementation, I noticed that many parts differed between the documentation and the demo, which has caused me to stop progressing. The current documentation seems outdated—would it be better to just learn from the demo alone?

davegarred commented 4 weeks ago

Hi @lambdalisue , it's quite possible that they've diverged at some point. Can you point to any specific places?

Note that the documentation can be found here.

lambdalisue commented 3 weeks ago

Thanks for clarifying. I'll follow the demo for now.

After the "Building an application" section, the differences between the documentation and demo became more noticeable. Are there any plans to update the documentation to align with the demo, or could PRs be submitted?

davegarred commented 3 weeks ago

Yes, PRs are ideal where you find these.