Skip to content

Add multisig operational runbooks and documentation guidance#408

Open
DicksonWu654 wants to merge 43 commits intosecurity-alliance:developfrom
DicksonWu654:multisig-guidebook-import
Open

Add multisig operational runbooks and documentation guidance#408
DicksonWu654 wants to merge 43 commits intosecurity-alliance:developfrom
DicksonWu654:multisig-guidebook-import

Conversation

@DicksonWu654
Copy link
Collaborator

Frameworks PR Checklist

Thank you for contributing to the Security Frameworks! Before you open a PR, make sure to read information for contributors and take a look at the following checklist:

  • Describe your changes, substitute this text with the information
  • If you are touching an existing piece of content, tag current contributors from the attribution list
  • If there is a steward for that framework, ask the steward to review it
  • If you're modifying the general outline, make sure to update it in the vocs.config.tsx adding the dev: true parameter
  • If you need feedback for your content from the wider community, share the PR in our Discord
  • Review changes to ensure there are no typos, see instructions below

@github-actions
Copy link

github-actions bot commented Mar 9, 2026

Sidebar Configuration Reminder

This PR includes added, renamed, or removed documentation files:

  • docs/pages/multisig-for-protocols/operational-runbooks.mdx (added)

Please ensure that:

  • The sidebar in vocs.config.tsx has been updated to include these files
  • New content has the dev: true parameter so it's marked as under development
  • Sidebar links match the file paths - use the preview deployment to verify

See Contributing Guide – Sidebar & Navigation for more details.


This is an automated reminder. If this PR doesn't need sidebar changes, you can ignore this message.

@DicksonWu654 DicksonWu654 marked this pull request as ready for review March 9, 2026 03:48
@DicksonWu654 DicksonWu654 marked this pull request as draft March 9, 2026 03:48
@github-actions
Copy link

github-actions bot commented Mar 9, 2026

built with Refined Cloudflare Pages Action

⚡ Cloudflare Pages Deployment

Name Status Preview Last Commit
frameworks ✅ Ready (View Log) Visit Preview 886e96e

@DicksonWu654 DicksonWu654 force-pushed the multisig-guidebook-import branch 2 times, most recently from baf0720 to f6cc005 Compare March 9, 2026 04:42
@scode2277 scode2277 added the content:add This issue or PR adds content or suggests to label Mar 9, 2026
@DicksonWu654 DicksonWu654 force-pushed the multisig-guidebook-import branch 2 times, most recently from dc5441c to ab49976 Compare March 14, 2026 23:27
@github-actions
Copy link

Sidebar Configuration Reminder

Documentation files update:

New in this push:

  • docs/pages/multisig-for-protocols/runbooks/emergency-pause.mdx (added) ← NEW
  • docs/pages/multisig-for-protocols/runbooks/index.mdx (added) ← NEW
  • docs/pages/multisig-for-protocols/runbooks/overview.mdx (added) ← NEW
  • docs/pages/multisig-for-protocols/runbooks/threshold-change.mdx (added) ← NEW
  • docs/pages/multisig-for-protocols/runbooks/token-transfer.mdx (added) ← NEW

Please ensure that:

  • The sidebar in vocs.config.tsx has been updated to include these files
  • New content has the dev: true parameter so it's marked as under development
  • Sidebar links match the file paths - use the preview deployment to verify

See Contributing Guide – Sidebar & Navigation for more details.


This is an automated reminder. If this PR doesn't need sidebar changes, you can ignore this message.

@DicksonWu654 DicksonWu654 force-pushed the multisig-guidebook-import branch from ab49976 to 7c3612f Compare March 14, 2026 23:42
@github-actions
Copy link

Sidebar Configuration Reminder

Documentation files update:

New in this push:

  • docs/pages/multisig-for-protocols/runbooks/signer-rotation.mdx (added) ← NEW

Previously seen:

  • docs/pages/multisig-for-protocols/runbooks/emergency-pause.mdx (added)
  • docs/pages/multisig-for-protocols/runbooks/index.mdx (added)
  • docs/pages/multisig-for-protocols/runbooks/overview.mdx (added)
  • docs/pages/multisig-for-protocols/runbooks/threshold-change.mdx (added)
  • docs/pages/multisig-for-protocols/runbooks/token-transfer.mdx (added)

Please ensure that:

  • The sidebar in vocs.config.tsx has been updated to include these files
  • New content has the dev: true parameter so it's marked as under development
  • Sidebar links match the file paths - use the preview deployment to verify

See Contributing Guide – Sidebar & Navigation for more details.


This is an automated reminder. If this PR doesn't need sidebar changes, you can ignore this message.

@DicksonWu654 DicksonWu654 force-pushed the multisig-guidebook-import branch from 7c3612f to 1562a6b Compare March 15, 2026 00:05
@DicksonWu654 DicksonWu654 marked this pull request as ready for review March 15, 2026 05:29
@DicksonWu654
Copy link
Collaborator Author

@scode2277 it's readdy to review now!

This is an example runbook. Review and customize it for your protocol before use. Add your specific multisig addresses,
token details, and verification procedures.

### Quick Reference
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We need to go down by one header level, otherwise the table of content doesn't track the sections as the scaling is not linear (see in the preview deployments)

Suggested change
### Quick Reference
## Quick Reference

| **Owner** | Treasury Admin |
| **Last Updated** | _Date_ |

### When to Use
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
### When to Use
## When to Use


Sending tokens (ETH, ERC20, SOL, SPL tokens) from a multisig to another address.

### Prerequisites
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
### Prerequisites
## Prerequisites

- [ ] Amount confirmed
- [ ] Reason for transfer documented or approved

### EVM (Safe) Procedure
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
### EVM (Safe) Procedure
## EVM (Safe) Procedure


### EVM (Safe) Procedure

#### 1. Create Transaction
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
#### 1. Create Transaction
### 1. Create Transaction

5. Select token and enter amount
6. Review and create transaction

#### 2. Verify Transaction
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
#### 2. Verify Transaction
### 2. Verify Transaction

- Verify token transfer event shows correct recipient and amount
- No unexpected transfers or approvals

#### 3. Sign
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
#### 3. Sign
### 3. Sign

DicksonWu654 and others added 28 commits March 16, 2026 22:23
Co-authored-by: Codex <codex@openai.com>
Co-authored-by: Codex <codex@openai.com>
Co-authored-by: Codex <codex@openai.com>
Co-authored-by: Codex <codex@openai.com>
Co-authored-by: Codex <codex@openai.com>
Co-authored-by: Codex <codex@openai.com>
Co-authored-by: Codex <codex@openai.com>
Co-authored-by: Codex <codex@openai.com>
Co-authored-by: Codex <codex@openai.com>
Co-authored-by: Codex <codex@openai.com>
Co-authored-by: Codex <codex@openai.com>
Co-authored-by: Codex <codex@openai.com>
Co-authored-by: Codex <codex@openai.com>
Co-authored-by: Codex <codex@openai.com>
Co-authored-by: Codex <codex@openai.com>
Co-authored-by: Codex <codex@openai.com>
Co-authored-by: Codex <codex@openai.com>
Co-authored-by: Codex <codex@openai.com>
Co-authored-by: Codex <codex@openai.com>
Co-authored-by: Codex <codex@openai.com>
Co-authored-by: Codex <codex@openai.com>
Co-authored-by: Codex <codex@openai.com>
Co-authored-by: Codex <codex@openai.com>
Co-authored-by: Codex <codex@openai.com>
Co-authored-by: Codex <codex@openai.com>
Co-authored-by: Codex <codex@openai.com>
Co-authored-by: Codex <codex@openai.com>
Co-authored-by: Codex <codex@openai.com>
@DicksonWu654
Copy link
Collaborator Author

Just left some comments to update the indentation as the table of content is not tracking the sections rn. I know they are a lot but I made it so you can just click "Commit suggestion" to implement them - hope that helps 🙏🏻 @DicksonWu654

tysm!! I just got my AI to do them so it doesn't look like it but it read all of yours and implemented each in different commits 😅

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

content:add This issue or PR adds content or suggests to

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants