docs: add glossary for protocol governance and emergency controls#871
Open
ayomidearegbeshola29-dev wants to merge 2 commits into
Open
Conversation
Add comprehensive definitions for governance and emergency control terminology used across the YieldVault-RWA protocol, including admin roles, emergency approvers, pause mechanisms, multisig governance, and related concepts.
|
@ayomidearegbeshola29-dev 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! 🚀 |
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
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.
Closes #763
PR Description — Issue #763: Documentation: Add glossary for protocol governance and emergency controls
Overview
This PR adds comprehensive glossary definitions for protocol governance and emergency control terminology used across the YieldVault-RWA codebase and documentation.
Implementation Summary
New Glossary Section
Added a new
## Governance & Emergency Controlssection todocs/GLOSSARY.mdcontaining 19 terms organized by functional domain:Admin & Access Control
Decentralized Governance
Emergency Controls
Pause & Risk Management
Timelock Mechanisms
Files Modified
docs/GLOSSARY.mdTerm Selection Rationale
Terms were selected based on:
contracts/vault/src/lib.rsand related modules (emergency.rs,permissions.rs,upgrade.rs)Consistency with Existing Documentation
The new terms follow established glossary conventions:
PauseReason)How to Verify
docs/GLOSSARY.mdcontracts/vault/src/lib.rs—PauseReason,DataKey,VaultErrorcontracts/vault/src/emergency.rs—EmergencyActionKind,EmergencyProposalcontracts/vault/src/permissions.rs—MultiSignerValidator,GovernanceConfigReferences
contracts/vault/src/lib.rscontracts/vault/src/emergency.rscontracts/vault/src/permissions.rscontracts/vault/src/upgrade.rsPR Status: Ready for review
Closes: #763