Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Help wanted (v1): Improve documentation #1056

Open
rasmus opened this issue Oct 20, 2024 · 0 comments
Open

Help wanted (v1): Improve documentation #1056

rasmus opened this issue Oct 20, 2024 · 0 comments

Comments

@rasmus
Copy link
Member

rasmus commented Oct 20, 2024

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.

@rasmus rasmus changed the title Help wanted: Improve documentation for v1 Help wanted v1: Improve documentation Oct 20, 2024
@rasmus rasmus changed the title Help wanted v1: Improve documentation Help wanted (v1): Improve documentation Oct 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant