Skip to content

docs: Revise Simulator Documentation #1302

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 8 commits into
base: main
Choose a base branch
from

Conversation

mustafauzunn
Copy link
Contributor

Reviewer Notes

Enhance simulator configuration documentation

Related Issue(s)

Fixes #407

Signed-off-by: Mustafa Uzun <mustafa.uzun@limechain.tech>
Signed-off-by: Mustafa Uzun <mustafa.uzun@limechain.tech>
@ata-nas ata-nas added the pull request label to get past the "label required" check when no label is needed or appropriate. label Jun 12, 2025
@ata-nas ata-nas added this to the 0.13.0 milestone Jun 12, 2025
Signed-off-by: Mustafa Uzun <mustafa.uzun@limechain.tech>
@mustafauzunn mustafauzunn changed the title docs: enhance simulator configuration documentation docs: Revise Simulator Documentation Jun 12, 2025
Copy link
Contributor

@jsync-swirlds jsync-swirlds left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for updating these.
Just a few minor suggestions.

Signed-off-by: Mustafa Uzun <mustafa.uzun@limechain.tech>
Signed-off-by: Mustafa Uzun <mustafa.uzun@limechain.tech>
Signed-off-by: Mustafa Uzun <mustafa.uzun@limechain.tech>
Signed-off-by: Mustafa Uzun <mustafa.uzun@limechain.tech>
@mustafauzunn mustafauzunn marked this pull request as ready for review June 13, 2025 07:31
@mustafauzunn mustafauzunn requested review from a team as code owners June 13, 2025 07:31
Copy link

codecov bot commented Jun 13, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

@@             Coverage Diff              @@
##               main    #1302      +/-   ##
============================================
- Coverage     80.81%   80.76%   -0.05%     
+ Complexity      956      954       -2     
============================================
  Files           111      111              
  Lines          4253     4253              
  Branches        449      449              
============================================
- Hits           3437     3435       -2     
- Misses          636      637       +1     
- Partials        180      181       +1     
Files with missing lines Coverage Δ Complexity Δ
...ck/simulator/config/data/BlockGeneratorConfig.java 76.47% <ø> (ø) 7.00 <0.00> (ø)
...block/simulator/config/data/BlockStreamConfig.java 100.00% <ø> (ø) 2.00 <0.00> (ø)
...ro/block/simulator/config/data/ConsumerConfig.java 100.00% <ø> (ø) 1.00 <0.00> (ø)

... and 1 file with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pull request label to get past the "label required" check when no label is needed or appropriate.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Revise Simulator Documentation
3 participants