Sequence diagrams for agent start and stop

[alesnovak-s1]

Sequence diagrams for agent start and stop

[github-actions[bot]]

Test Results

     29 files  ±0       29 suites  ±0   49m 46s :stopwatch: +15s 1 443 tests ±0  1 422 :heavy_check_mark:  - 1    20 :zzz: ±0  1 :x: +1  9 736 runs  ±0  9 478 :heavy_check_mark:  - 1  257 :zzz: ±0  1 :x: +1 

For more details on these failures, see this check.

Results for commit 0370c6bf. ± Comparison against base commit 42e8fd07.

[codecov[bot]]

Codecov Report

Merging #1160 (0370c6b) into master (42e8fd0) will decrease coverage by 0.07%. The diff coverage is n/a.

@@            Coverage Diff             @@
##           master    #1160      +/-   ##
==========================================
- Coverage   79.54%   79.47%   -0.07%     
==========================================
  Files         186      186              
  Lines       42888    42888              
  Branches     4807     4807              
==========================================
- Hits        34114    34084      -30     
- Misses       7576     7594      +18     
- Partials     1198     1210      +12     

see 10 files with indirect coverage changes

[alesnovak-s1]

Looks good to me overall. I am not fully sure how those diagrams are created, but if they are created manually, there is a risk that this diagram may become more and more outdated over time, due to a high chance that a developer will simply forget to reflect his changes also in diagrams. Not sure if that's possible, but it would be good to have some automated update mechanism for that. @tomaz-s1 WDYT?

That's a good point @ArthurKamalov, I will look into integrating it in a same way monitors documentation is done.

[tomaz-s1]

Yeah, I assume Arthur just means embedding mermaid diagram inside a code as a docstring (e.g. top level module docstring) and then generate markdown from that.

I think that's fine and doing anything more than that (aka programmatically generating complete diagram from the code flows) is not really feasible and worth the time investment.