Skip to content

docs: document recuse_arbiter() - #463

Merged
shakurJJ merged 1 commit into
shakurJJ:mainfrom
Praizfotos:docs/334-document-recuse-arbiter
Aug 28, 2026
Merged

docs: document recuse_arbiter()#463
shakurJJ merged 1 commit into
shakurJJ:mainfrom
Praizfotos:docs/334-document-recuse-arbiter

Conversation

@Praizfotos

Copy link
Copy Markdown

Summary

Documents the arbiter recusal flow for shipments, including when an arbiter can recuse themselves and how the replacement arbiter process is triggered.

Changes

  • Added "When to use recusal" — conflict of interest, workload constraints, expertise matching
  • Documented preconditions and authorization requirements
  • Added 7-step execution flow breakdown
  • Documented round-robin replacement selection mechanics
  • Documented state changes (shipment.arbiter, arb_pool_idx, event emission)
  • Documented all failure cases and panic messages
  • Added comparison table: recuse vs rotation vs backup activation vs slashing
  • Added CLI example for invoking the function

Closes #334

Comprehensive documentation of the arbiter recusal flow including:
- When to use recusal (conflict of interest, workload, expertise)
- Preconditions and authorization requirements
- Step-by-step execution flow
- Round-robin replacement selection details
- State changes during recusal
- Failure cases and error messages
- Comparison table with other arbiter management mechanisms
- CLI example for invoking the function

Closes shakurJJ#334
@drips-wave

drips-wave Bot commented Aug 28, 2026

Copy link
Copy Markdown

@Praizfotos Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits.

You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀

Learn more about application limits

@shakurJJ
shakurJJ merged commit 9b34866 into shakurJJ:main Aug 28, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: document recuse_arbiter() in README

3 participants