Update Safe Harbor documentation for clarity and accuracy#356
Open
DicksonWu654 wants to merge 7 commits intosecurity-alliance:developfrom
Open
Update Safe Harbor documentation for clarity and accuracy#356DicksonWu654 wants to merge 7 commits intosecurity-alliance:developfrom
DicksonWu654 wants to merge 7 commits intosecurity-alliance:developfrom
Conversation
- Revised the on-chain adoption guide to reflect the creation of Agreement contracts via the AgreementFactory instead of AgreementV2 contracts. - Updated references to the Safe Harbor Registry address and the method for registering agreements. - Enhanced the overview section with updated asset protection statistics and clarified definitions regarding active exploits and whitehat agreements. - Added details on CAIP-2 chain identifiers in the scope terms section. - Improved language consistency and formatting across multiple documents, including the self-adoption guide and self-checklist.
- Replaced the outdated Safe Harbor Agreement link in the self-adoption guide with the updated URL for improved accuracy and accessibility. - Ensured the language remains consistent with the overall documentation style.
|
@DicksonWu654 is attempting to deploy a commit to the Security Alliance Team on Vercel. A member of the Team first needs to authorize it. |
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
scode2277
reviewed
Feb 2, 2026
Collaborator
|
left a small indication for a link placeholder :)) |
scode2277
approved these changes
Feb 2, 2026
- Updated the description to emphasize the legal protection provided to protocols and security researchers during DeFi exploits. - Improved the overview section with a clear definition of Safe Harbor as an open-source framework. - Enhanced image alt text for better accessibility and context. - Revised the "How Safe Harbor Protects Your Protocol" section for clarity on pre-authorization processes. - Updated the "How to Adopt Safe Harbor" section to reflect a more user-friendly onboarding process.
…meworks into safe-harbor-docs-update
…ine content and enhance clarity. This change focuses on maintaining concise documentation while ensuring essential information remains accessible.
Collaborator
|
Hey @DicksonWu654, please feature this guide for the frontmatter description. It has to fit max 160 chars otherwise it gets cut by the search engines |
- Updated the description to enhance clarity and emphasize legal protections for protocols and researchers. - Improved formatting of import statements and image tags for better readability. - Revised sections for clearer definitions and streamlined content presentation. - Enhanced accessibility by updating alt text for images and ensuring consistent terminology throughout the document.
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
2 participants
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.
Frameworks PR Checklist
Safe Harbor is now upgrading to V3, so I'm updating these docs to reflect the new structure. Additionally, some stats about Safe Harbor are out of date so just updating them to be up to date
vocs.config.tsadding thedev: trueparameter