Much better documentation needed about snapper HOT 5 CLOSED

Hey @jzabroski,
Thanks for the issue. I've been meaning to improve the documentation for a while and this feedback is super valuable. I'll start adding some of the details you mentioned in the next couple of months.
I'll be quite busy for the next couple of weeks so will try to slot in some time here and there.

If you've got any more suggestions on how I can improve the documentation please add them to this issue.

May I ask other than documenting the things you've suggested, is there anything else stopping you from using this library in your OSS project?

from snapper.

I think contributors need to understand the design pattern easily. It's a little worrisome it would take you months to describe the elevator pitch for the project, other than to say it's inspired by Jest. Don't let that hard effort you've put in go to waste. A little effort now will inspire others to help you. The "compound interest" of others helping out is how you build a larger project.

As some context, I help co-maintain FluentMigrator, and while the initial first sentence elevator pitch is that it allows Ruby on Rails style migrations, it quickly goes into what a migration is, the benefits of using migrations, and how you use it to solve real world problems.

Good luck.

from snapper.

Sorry I worded my earlier message incorrectly.
By taking a couple of months I meant getting everything done not just the suggestions made by you.
I've got plans to revamp the docs so they are a bit easier to follow and explain a lot more about how/why Snapper works the way it does.

I'll definitely be starting with things like the readme and elevator pitch first, hopefully have it done by the end of next week. I know even a week is quite long but unfortunately I have quite a bit of stuff going on in the personal life at the moment which can't be avoided.

from snapper.

I think the thing you got going for you is you have no competition in the .NET community. So no, a week is not long. Thanks for your attentiveness!

from snapper.

Hey @jzabroski,

I've updated the documentation quite a bit now. Would mind having a quick look and see if there is anything else you think I could improve on?

Thanks heaps for your suggestions! 😄

from snapper.