Documenting examples better?

After struggling and pestering you guys for a few days, I’d like to contribute to better examples for this. I’m not sure where. A few ideas:

• I can add more to the Readme file. But we need a little more than that.
• Do you intentionally not create wiki pages?
• Is there another place to create documentation?

I made my own example app that makes creative user of appsettings.Development.json to hide secrets (Application Insights Key). Of course then I added the appsettings.Development.json to .gitignore to hide the sauce.

I’m going to keep that example for myself, but I could add that sort of stuff to your sample app. I could also store Environment variables in the launch config.

Just looking for thoughts on where you think docs should go.

[tsimbalar]

Thanks @merbla for the blog posts, I hadn’t seen your latest articles about Serilog. Really cool !

The Serilog ecosystem has grown so much that maintaining all its documentation in a centralized location and keeping it up-to-date would be a huge endeavor.

It is also true that the Wiki features of GitHub have some limitations (for instance, one cannot issue a PR with changes to apply to the wiki) that make it harder to accept contributions.

I kind of wish we had a more “unified”/discoverable documentation entry point where documentation from all the repos would be browsable “in-place” (without navigating through repos and more repos), and where maintainers of each repo can update and add content.

For specific use-cases like “how do I do this …”, I still believe the community-provided content is the best approach (blogs, gists, stackoverflow) and having a page with links to those could be useful.

[tsimbalar]

Closing this issue as the discussion is now moved to serilog/serilog#1164 .

Cheers !