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

ASPNET Core Documentation Updates #126

Closed mmillican closed 6 years ago

mmillican commented 6 years ago

I'll be sending along a PR later this week for this, but wanted to get it documented and possibly open for discussion.

I noticed a few discrepancies with the docs for getting Exceptional setup in Core, namely with setting up stores and Application name (via code, not config). More to come, just wanted to note here before I forgot.

mmillican commented 6 years ago

Thought I had last night: creating a page/list of the configurable options. I realize some of this is in the example appsettings.json, but to me its still sometimes helpful to have a list of all the options for quick reference. Thoughts? If interested, I'd be happy to put something together.

NickCraver commented 6 years ago

@mmillican sorry I didn't see this in email, I'm all for documentation here and it's immensely appreciated.

I have this today: https://nickcraver.com/StackExchange.Exceptional/Settings - which sounds like what you're after but could definitely use some improvement (e.g. should we fully qualify each name? - I was torn there because in a lambda that's not use you use there, but maybe some lambda examples up top solves that confusion?)

NickCraver commented 6 years ago

I think we've tidied all these - closing out :)

mmillican commented 6 years ago

Sorry @NickCraver I apparently missed your reply and this page also. This looks good. I'm pondering possibly trying out a table format, like so:

Section Heading

Description

| Field | Type | Default | Description |

Thoughts?