Docs: add follower node documentation. #5181
Conversation
winder
force-pushed
the
will/follower-doc
branch
from
f5ec400 to
14a1eef
Compare
docs/follower_node.md
Outdated
| ## Usage | ||
|
|
||
| New public endpoints are available to control the node: | ||
| * `GET /v2/ledger/sync` - fetch the current minimum sync round. |
There was a problem hiding this comment.
what is a "sync round"? You introduce the term without explaining, I think
There was a problem hiding this comment.
this is still confusing to me. "... round the node is synchronized with" does that mean the round the node is caught up to? I'm confused because what is then the "minimum sync round"?
Maybe this deserves a little higher level explanation right above where you lay out the endpoints?
docs/follower_node.md
Outdated
| ## Usage | ||
|
|
||
| New public endpoints are available to control the node: | ||
| * `GET /v2/ledger/sync` - fetch the current minimum sync round. |
There was a problem hiding this comment.
this is still confusing to me. "... round the node is synchronized with" does that mean the round the node is caught up to? I'm confused because what is then the "minimum sync round"?
Maybe this deserves a little higher level explanation right above where you lay out the endpoints?
Codecov Report
@@ Coverage Diff @@
## master #5181 +/- ##
==========================================
- Coverage 53.60% 53.58% -0.03%
==========================================
Files 439 439
Lines 54934 54934
==========================================
- Hits 29447 29436 -11
- Misses 23208 23210 +2
- Partials 2279 2288 +9 see 11 files with indirect coverage changes 📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
winder
assigned winder, JasonWeathersby and shiqizng and unassigned JasonWeathersby, Eric-Warehime, shiqizng and algoanne
Summary
Some general information about follower nodes.
Test Plan
N/A