Simmy docs

[vany0114]

Simmy docs.

Didn't run the docs website locally bc I don't know how, if you guys think I should please let me know how.

[peter-csala]

Simmy docs.

Didn't run the docs website locally bc I don't know how, if you guys think I should please let me know how.

You just have to run these two commands and you can test the documentation website locally:

Download the docfx among other tools

dotnet tool restore

Build and run the website

dotnet docfx docs/docfx.json --serve

visit the http://localhost:8080 url

[peter-csala]

@vany0114 Could you please update the PR description in a way that you highlight what is already done and what's still missing? Then we can split the remaining work.

[martincostello]

Some words need adding to the spellcheck dictionary and the C# snippets need to be added as code.

[peter-csala]

@vany0114 Please allow me (@peter-csala) to contribute to your branch (otherwise I have to create a fork from your branch).

[vany0114]

@vany0114 Please allow me (@peter-csala) to contribute to your branch (otherwise I have to create a fork from your branch).

@peter-csala done

[martintmk]

Added some comments, otherwise it looks really great @vany0114 and @peter-csala!

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (dc8248d) 84.65% compared to head (a2f0986) 84.65%.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #1883   +/-   ##
=======================================
  Coverage   84.65%   84.65%           
=======================================
  Files         309      309           
  Lines        6828     6828           
  Branches     1050     1050           
=======================================
  Hits         5780     5780           
  Misses        839      839           
  Partials      209      209           

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

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

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[peter-csala]

@vany0114 When I was reading the chaos engineering page I was missing further resources links. Since the page talks mainly about simmy not about chaos engineering I think it might make sense to add links which are explaining the fundamentals (like hypothesis, steady-state, experiment, blast radius, etc.)

[martintmk]

Let's get rid of extra logos and .

Wdyt, @martincostello anything else is missing?

[martincostello]

I have three unresolved comments, but otherwise I'm happy if you and @vany0114 are happy.

[peter-csala]

@martincostello , @martintmk For me it seems a bit odd to have Chaos engineering section between Resilience strategies and Resilience pipelines. What do you guys think where should we place it inside the TOC?

[martincostello]

Let's put it just before the advanced section.

[peter-csala]

Is there anything that needs to be addressed or can we ?

[martintmk]

Is there anything that needs to be addressed or can we ?

I think it fine to merge. @martincostello ?

[martincostello]

Just waiting on some feedback from @vany0114.

[vany0114]

@peter-csala thanks a lot for the help! it looks good to me.