azure-sdk-for-go icon indicating copy to clipboard operation
azure-sdk-for-go copied to clipboard

Stop providing snippets in markdown

Open RickWinter opened this issue 2 years ago • 0 comments

All snippets and samples should be compiled to ensure correctness. The Go tooling provides this validation when the code is contained in documentation examples.

For each package, we need to ensure

  1. Readme samples are references to Examples in documentation on pkg.go.dev
  2. Example code in markdown is removed.
  3. All Champion scenarios have corresponding examples in doumentation.

RickWinter avatar Aug 04 '22 16:08 RickWinter