Contribute Examples

The examples are generated by GitVersion tests as Mermaid sequence diagrams. The documentation embeds those sources and renders them in the browser with a pinned Mermaid version. These links are useful when changing a diagram:

The tests are quite simple. Using the methods on the fixture itself will record that action in the sequence diagram. If you do not want the action recorded perform the action directly on the repository (fixture.Repository.)

The documentation scenarios live in DocumentationSamplesForGitFlow.cs and DocumentationSamplesForGitHubFlow.cs.

After changing a documentation scenario, regenerate and verify the diagrams:

./build.ps1 -Stage docs -Target GenerateMermaidSources
./build.ps1 -Stage docs -Target ValidateMermaidDiagrams

Commit the updated .mmd source under docs/diagrams/.