-
Notifications
You must be signed in to change notification settings - Fork 21
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
added first draft of profiler docs #111
Conversation
Codecov Report
@@ Coverage Diff @@
## main #111 +/- ##
=======================================
Coverage 97.56% 97.56%
=======================================
Files 13 13
Lines 1601 1601
=======================================
Hits 1562 1562
Misses 39 39 |
docs/profiler.md
Outdated
## How to use the values | ||
|
||
``` | ||
"smeshing-proving-opts": { | ||
"smeshing-opts-proving-nonces": 144, | ||
"smeshing-opts-proving-threads": 0 | ||
}, | ||
``` | ||
|
||
Place that in your node config. Please note that the values are just an example and you need to use your own values. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
People will not know where to place it in the config. Consider specifying the whole path in JSON:
{
"smeshing": {
"smeshing-proving-opts": {
"smeshing-opts-proving-nonces": 144,
"smeshing-opts-proving-threads": 0
}
}
}
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not sure honestly, that would assume that people know how to merge json. I gave flat part of a file that they have to add (including semicolon at the end)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
OK, but where to put it? I had to open source code and look it up to write the proposed version 😂
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
hmm ok you convinced me. I'll add "smashing" also :) but I'll drop the top most {} ok?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@poszu check now, changed my mind a bit and tried to make it more explicit.
Content-wise LGTM, but it could be restructured and better worded. Do we really want to put exact mainnet values (like 12h cycle gap, network id) here? I see that it can help people right now, but could be misleading if they change (the cycle gap for sure will change at some point). |
Co-authored-by: Matthias Fasching <[email protected]> Co-authored-by: Bartosz Różański <[email protected]>
7689f89
to
8f9c243
Compare
Added some guides about profiler tool.