I hope you’re doing well and you’re happy dry-rb users We’ve come a long way since dry-rb has been established in 2015 and I’m really proud of what we’ve achieved together. All the gems provide a lot of very powerful features; furthermore, due to the nature of dry-rb you can compose gems into more powerful abstractions.
This is all great and awesome but there’s one big caveat: for many people it’s a challenge to figure out how exactly they want to use dry-rb gems. For us, core developers and maintainers, it’s a challenge to provide educational resources in the form of user docs, api docs, tutorials, guides and so on.
I’ve been thinking about this problem and trying to solve it for a couple of years. Unfortunately the harsh reality is that I, as well other core devs, simply never have enough time to properly handle documentation and other resources. This is a huge effort, easily comparable to the effort that goes into implementation and maintenance of the code itself.
Here’s the current state of things when it comes to docs:
- All gems have user documentation on dry-rb.org
- Most gems have decent API docs on rubydoc.info
- We have a zulip chat and this forum where people can ask questions and get support
This is good but here are some issues:
- Many user docs on dry-rb.org have uncovered features
- Docs should be organized better - gems should be grouped into “tiers” so that it’s easier to understand which gems are “core” and which are more high-level, and high-level guides written to show how the gems can work together
- API docs should be improved and better integrated
- Zulip (chats, in general) are not a good way to provide support - we’d prefer to move “support” to this forum
Given that literally years are passing and we just can’t find enough time to properly deal with all of this the time has come to openly ask for help from the community!
We need a team of documentation maintainers - if you’re interested in helping with this or have some feedback to share - please do this in this thread!