NServiceBus icon indicating copy to clipboard operation
NServiceBus copied to clipboard

Consider linking exception messages to our docs

Open kbaley opened this issue 3 years ago • 1 comments
trafficstars

In many of our exceptions, we provide pretty clear guidance on how to fix things but there is only so much context we can provide in a short error message. In many cases, directing users to documentation could bridge that gap but historically, we have avoided this so we don't need to change code if we move documentation around. But it still might be worth investigating whether we can do it without it becoming a maintenance burden.

One suggestion: create help URLs like particular.net/help/00123456. This doesn't completely remove the need for maintenance but does allow us to address discrepancies without having to recompile our code.

kbaley avatar Jul 22 '22 20:07 kbaley

Another suggestion from @mikeminutillo: The way it could work is to drop a redirect in the docs page for that help url. That way, if you wanted to change a docs page, you could search all of our repos for the help urls and see where they are referenced in the code.

kbaley avatar Jul 22 '22 20:07 kbaley