Where to find documentation?

Question

Where to find documentation?

Closed this issue 4 years ago · 8 comments

Hi.

Just wanted to find out where the documentation for this package is? There's no information on the Readme and the wiki isn't accessible(It just keeps redirecting to the code tab when clicked).

Answer 1 · 2019-02-26T10:06:56.000Z

I would also appreciate some info on this.

Answer 2 · 2019-02-28T20:32:29.000Z

There is an example project.

Answer 3 · 2019-02-28T20:32:53.000Z

Let me know if its not enough

Answer 4 · 2019-02-28T20:42:48.000Z

Yeah I think a bit more would be a lot better. It's not easy to figure out what the options in the config are and such just by example. You really need both, especially given that this project is directly referenced by NLog and as such is not merely a hobbyist "for fun" project, but is actually a project some people may hope to use in professional contexts(as I did and ended up turning to Serilog instead). It's not that the example is bad, but that it's much easier to process a reference documentation when trying to remember what a parameter does or something like that.

Answer 5 · 2020-05-07T13:24:43.000Z

#13 + #16 Have improved Readme.md with more examples.

Answer 6 · 2020-05-08T09:23:49.000Z

They are both merged

Answer 7 · 2020-05-08T09:30:24.000Z

Yes but this issue was raised before the PRs was merged. Maybe this issue can be closed, unless something is missing?

Answer 8 · 2020-05-08T12:12:14.000Z

So can we close it?
Builds are automated now, it will be easier to publish packages.