Help wanted (v1): Improve documentation

[rasmus]

The new documentation site is now properly up and running on https://geteventflow.net/, and while GitHub Workspaces have helped cleanup and make the documentation (somewhat) ready for a real release of v1, there's still several areas that could do with a loving hand.

Here's a list of areas the needs improvements.

Documentation improvements

• All the "integration" section is in poor shape and could really need a brush up. Specifically, with better code examples and text that helps developers along the way
• Improve the quality of code examples. Currently they are rather limited and should be expanded to include a bit more context as many of them are merely one or two lines
• Provide a consistent reference on how to install the feature extending NuGet packages

General quality and features

• Page listing all the many contributors of EventFlow. The project has received many contributions over the years and having a list of names would be awesome ❤️
• Page listing community made guides, examples and projects to help developers get even more inspiration
• Page listing the current set of packages provided as of v1 with links to documentation on setting them up in the "integrations" section

If you decide to help out, then please create relatively small PRs with isolated changes to minimize the chance of others working on the same.

[alexeyfv]

Hi,

I’ve been using EventFlow for a few weeks. During this time, I read a lot of EventFlow documentation and looked at the source code. I made some notes on how the documentation can be improved, because it was hard for me to understand how to:

1. Work with aggregates without CQRS.
2. Read the event log of an aggregate.
3. Configure the database (SQL Server) and apply migrations.
4. Update events.
5. Use async event subscribers with Hangfire.
6. Write integration tests with async event subscribers.

I also found some typos in the documentation.

What do you think would be useful to add to the documentation from my list? I can help with that.

[rasmus]

Hi @alexeyfv ❤️ that all sounds very useful. As mentioned, the documentation is far from what I had envisioned originally.

[alexeyfv]

Nice. I'll prepare the 1st pull request about working with aggregates without CQRS in the near time. Any suggestions on where to put this example?

[alexeyfv]

Improvements to the Aggregate page: #1069

[alexeyfv]

Improvements to the Event stores page: #1071