Please add examples with Ash documentation

There is also an aspect here of the methodology behind support. The way that we help people on forums etc. is not necessarily by providing a fully worked solution to their problem.

Please don’t get frustrated when someone links you to documentation they think will help. This is what is supposed to happen first. You can say “I read that but I don’t understand it”. And that gives us information on what needs to be improved on the docs. But just writing out a code example in response to a question is not how our documentation improves.

We don’t have full context of someone’s app, we don’t know what else your code base contains, or what else you do or don’t know. From your perspective you have one very simple problem and you know exactly what you don’t know. But we deal with folks at various skill levels with Ash all the time.

Regardless, as I mentioned in my original response, we have an explicit goal of going over all of the docs and adding examples to as many places as possible. Hopefully that will make some of this easier.

6 Likes