Improve documentation and examples

[audunhalland]

As the author, it's a little unclear to me whether the documentation of this crate is adequate and understandable. I fear that my imagination on how the crate can be used is somewhat limited, because I have to think about the technical details at the same time. I'd appreciate external contributions from a pure usability-perspective, high-level improvement tips, describing novel design patterns, etc.

[kemiblueoyes]

@audunhalland Hi. I might be able to help. Are there docs that you’ve seen that you’d like entrait docs to emulate?

Meanwhile, here are some things to think about:

Also, when writing docs to think of your target audience in levels. In this case, what is the minimum level of technical acumen required to use your tool? For example is the minimum a developer new to building Rust applications or learning the the Rust programming language?

It also helps users to adopt your tool when you contextualize its purpose from the very beginning. On the first page where you describe what entrait is and what it does, you could give specific examples of where you would use entrait: a specific type of application and an example of a specific functions to define and the implemented trait it generates from that function. (Or something to that effect). This helps people quickly understand potential use cases and most important, imagine their own use cases.