NickCraver / StackExchange.Exceptional

Error handler used for the Stack Exchange network
https://nickcraver.com/StackExchange.Exceptional/
Apache License 2.0
863 stars 171 forks source link

Documentation Please #53

Closed CptRobby closed 9 years ago

CptRobby commented 10 years ago

The documentation for this project is abysmally sparse: 2 wiki pages that only show the simplest of setups. Google searches yielded nothing other than the following categories:

Searches on SO and SE were no better. Looking in the code doesn't help much either since it isn't even well documented.

Documentation for emailing errors is especially absent. For example, "How do I prevent it from sending an email for each and every exception?" "How do I customize the format of the email?" "How do I filter out certain exceptions from being emailed, but still have them logged to the database?" These are just a few of the questions that need to be addressed with some documentation.

Thanks in advance! :)

CptRobby commented 9 years ago

Please pardon the earlier rant, @NickCraver. Since the time that I opened this issue, I've pretty much figured out everything I needed to get it to work and to customize it according to my needs. It's an excellent tool and I expect that I'll be using it quite often in my projects.

Undoubtedly, better documentation would help others who aren't able to just dig into the code to make sense of it. But I know that fully documenting this (and maintaining that documentation) probably isn't any easier for this project than it is for me to document my projects. And you probably don't get paid for it either.

Peace :)