show usage of merging snippets into docs

[SimonCropp]

Thoughts on making the code snippets in your readme being extracted from real code? I find it makes it easier to maintain docs. Changes in you api are automatically kept in sync and snippets can be taken from tests to ensure those snippet behave as expected

Docs https://github.com/SimonCropp/MarkdownSnippets

I also added a GH Action https://github.com/SimonCropp/MarkdownSnippets/blob/master/docs/github-action.md This can be useful to ensure md docs are in sync when .source files are edited online, and without needing to re-generate the docs locally.

[codecov-commenter]

Codecov Report

Merging #320 (0e18f67) into main (46316fa) will not change coverage.
The diff coverage is n/a.

@@            Coverage Diff            @@
##              main      #320   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           16        16           
  Lines         1129      1128    -1     
=========================================
- Hits          1129      1128    -1     

Flag	Coverage Δ
linux	100.00% <ø> (ø)
macos	100.00% <ø> (ø)
windows	100.00% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
...ClientInterception/HttpClientInterceptorOptions.cs	100.00% <0.00%> (ø)

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 46316fa...0e18f67. Read the comment docs.

[martincostello]

This looks cool 👀

I remember way back that I saw the .NET notebook/try.dot.net (or something, I forget) that showed having code samples based on real code that checked it compiled and passed that would have been nice to have. You're right, all the examples in the README are pretty much just taken from the Examples test class (or vice-versa).

I'll take a proper look at it later today 👍

[martincostello]

/cc @slang25 - could be good for justeattakeaway/JustSaying#902 too.

[martincostello]

Some minor comments, but otherwise this looks great!