Update orbiter.md LeavingTheProgram section #1335
Conversation
aljosamakevic
added
A2 - Maintenance Minor
aljosamakevic
temporarily deployed
to
n8n-sending
GitHub Actions
Inactive
aljosamakevic
temporarily deployed
to
n8n-receiving
GitHub Actions
Inactive
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
aljosamakevic
requested review from
dawnkelly09 and
eshaben
and removed request for
kapetan3sid
albertov19
left a comment
albertov19
left a comment
There was a problem hiding this comment.
Left some feedback. Ideally we can add two quick screenshots?
Co-authored-by: albertov19 <[email protected]>
Co-authored-by: albertov19 <[email protected]>
dawnkelly09
left a comment
dawnkelly09
left a comment
There was a problem hiding this comment.
Felt like the steps could be a little clearer. Also removed language about number of pools to future proof a bit.
There was a problem hiding this comment.
Pull request overview
This pull request updates the documentation for how an orbiter can leave the Moonbeam Orbiter program. The changes expand the previously brief single-step instruction into a detailed two-step process with clearer guidance on required parameters.
Key changes:
- Restructured leaving process into two distinct steps: first leaving the collator pool, then unregistering
- Added detailed instructions for finding required parameters using chain state calls
- Included specific guidance on using Polkadot.js interface
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| node-operators/networks/collators/orbiter.md | Updated LeavingTheProgram section with expanded two-step process and parameter lookup instructions |
| llms-full.txt | Synchronized documentation changes with additional Moonbeam-specific pool count information |
| llms-files/llms-node-operators-and-collators.txt | Synchronized documentation changes with additional Moonbeam-specific pool count information |
Comments suppressed due to low confidence (1)
llms-full.txt:1
- The additional context 'On Moonbeam, it should be five as of writing this' is included in llms-full.txt and llms-files/llms-node-operators-and-collators.txt but missing from the main orbiter.md file. This information would be helpful to users in the primary documentation as well for validation purposes.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| 1. Execute the chain state call `moonbeamOrbiters.collatorsPool()` with no arguments, making sure to disable "include option" in [Polkadot.js](https://polkadot.js.org/apps/#/explorer){target=\_blank}. Make note of your collator pool address and the number of pools as you will need them in the following steps. | ||
|
|
||
|  | ||
|
|
||
| 2. Execute `moonbeamOrbiters.orbiterLeaveCollatorPool(collator)` extrinsic where the `collator` param is the address of the collator pool you are in. | ||
|
|
||
|  | ||
|
|
||
| 3. Execute `moonbeamOrbiters.orbiterUnregister(collatorsPoolCount)` where `collatorsPoolCount` is the number of pools. | ||
|
|
||
|  |
There was a problem hiding this comment.
I don't think this will render properly, I didn't spin it up but please check. The images probably need to be indented so that the list order is respected and all of these don't show up as 1's
| An orbiter may leave the program and receive their bond back without any delay. The only limitation on this is if the orbiter is currently active they cannot leave; once they are no longer active they can leave at any time by issuing the `moonbeamOrbiters.orbiterUnregister()` extrinsic. | ||
| An orbiter may leave the program and receive their bond back without any delay. The only limitation is that if the orbiter is currently active, they cannot leave. Once they are no longer active (i.e. once their assigned active round ends and block production authority rotates to another orbiter), they can leave at any time by following these steps: | ||
|
|
||
| 1. Execute the chain state call `moonbeamOrbiters.collatorsPool()` with no arguments, making sure to disable "include option" in [Polkadot.js](https://polkadot.js.org/apps/#/explorer){target=\_blank}. Make note of your collator pool address and the number of pools as you will need them in the following steps. |
There was a problem hiding this comment.
UI elements are always bold, not quotes
There was a problem hiding this comment.
The biggest issue I have with this is we're not telling the users where to go on Polkadot.js Apps. Like for this image they need to go to Developer > Chain State and the next image they need to go to Developer > Extrinsics
See other pages for reference on how we've handled this in the past: https://docs.moonbeam.network/node-operators/networks/collators/activities/#stop-collating
There was a problem hiding this comment.
In the reference link, those are how we used to images with arrows and numbers combined. We don't do that anymore instead it would just be the Steps feature in Snagit, which are the circles with the numbers in it. Or if you're only highlighting one item, you wouldn't use the steps feature, you'd use a single arrow. The arrows you create in Snagit should look like the old arrows you see in the images on that reference page.
There was a problem hiding this comment.
1-1-1 numbering everything else looks good.
This pull request updates the documentation for how an orbiter can leave the program in the Orbiter network. The instructions have been expanded to clarify the required steps and provide more detailed guidance for users.
Documentation improvements:
moonbeamOrbiters.orbiterLeaveCollatorPool(collator)extrinsic, and second, executingmoonbeamOrbiters.orbiterUnregister(collatorsPoolCount). Additional guidance is provided on how to find the necessary parameters using chain state calls and Polkadot.js.