docs: add multisig signing process doc, fix docs index and dead links (EXSC-711) - #2126
Draft
0xDEnYO wants to merge 2 commits into
Draft
docs: add multisig signing process doc, fix docs index and dead links (EXSC-711)#21260xDEnYO wants to merge 2 commits into
0xDEnYO wants to merge 2 commits into
Conversation
Contributor
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Repository UI Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
WalkthroughChangesMultisig process reference
Documentation navigation updates
Estimated code review effort: 2 (Simple) | ~10 minutes Possibly related PRs
Suggested labels: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/MultisigSigningProcess.md`:
- Around line 14-17: Revise the governance descriptions in
MultisigSigningProcess.md, including the direct-broadcast section and the flows
around diamondCut, pause, and unpause, so Safe multisig and timelock controller
usage are mandatory for production and never presented as bypassable. Clearly
label direct EOA, omitted-timelock, and pause paths as non-production or
explicitly authorized break-glass procedures, document their enforced guards,
and state that unpause may bypass only the delay while Safe threshold/quorum
remains mandatory.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository UI
Review profile: CHILL
Plan: Pro Plus
Run ID: bf45c4f8-8ce6-486d-89eb-2f1d255185bd
📒 Files selected for processing (3)
README.mddocs/MultisigSigningProcess.mddocs/README.md
…eak-glass (EXSC-711) Addresses CodeRabbit review on PR #2126: the doc described SEND_PROPOSALS_DIRECTLY_TO_DIAMOND, the untimelocked deployUpgradesToSAFE diamondCut, pause, and unpause without making clear that none of them weaken Safe governance on a live production diamond. Each is now scoped to bring-up/legacy/break-glass with its enforced guard named, and unpause states that only minDelay is bypassed while Safe threshold/quorum stays mandatory. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Which Linear task belongs to this PR?
https://linear.app/lifi-linear/issue/EXSC-711
Why did I implement it this way?
The repo documents contracts thoroughly but the processes around them — how a change gets deployed, audited, proposed to the multisig, signed and executed — live in people's heads, in Slack threads, and partially in
.agents/commands/multisig-rollout.md. This addsdocs/MultisigSigningProcess.mddescribing the process as it exists today, not as we would like it to be. Everything in it was verified against the code onmain; it cites script paths and function names rather than line numbers, which rot.The check table carries an explicit "Enforced by" column mapping each rule to the script or workflow that enforces it. That was deliberate: it makes the difference between "we have a convention" and "the system enforces a convention" visible at a glance, and it makes gaps obvious rather than implicit.
There is an honest section on what the signer still has to verify manually. It would have been easy to write a doc that implies the tooling covers more than it does; that would be worse than no doc.
Housekeeping included because it is the same edit surface:
docs/README.mdwas missing several process docs that already exist, and the rootREADME.mdlinked./conventions.md— a file that no longer exists — in four separate places, now pointed at.agents/rules/.A short "planned improvements" section at the end is clearly marked as proposal-stage and not yet implemented, so the doc does not read as describing features we do not have.
Governance impact (rule 105): documentation only. No change to any script, workflow, Safe threshold, timelock delay, role, or transaction authorization path.
Checklist before requesting a review
Checklist for reviewer (DO NOT DEPLOY and contracts BEFORE CHECKING THIS!!!)