Skip to content

docs: SDK new migration guide#817

Merged
dasanra merged 8 commits intomainfrom
docs/sdk-migration-guide
Mar 27, 2026
Merged

docs: SDK new migration guide#817
dasanra merged 8 commits intomainfrom
docs/sdk-migration-guide

Conversation

@yagopv
Copy link
Copy Markdown
Member

@yagopv yagopv commented Mar 9, 2026

This pull request adds migration documentation for upgrading to protocol-kit v7, introducing support for Safe v1.5.0 smart contracts and outlining several breaking and non-breaking changes. It also updates the documentation metadata to include the new migration guide

Documentation updates:

  • Added a new migration guide, migrate-to-v7.md, detailing all breaking changes, new features, and deprecations for Safe v1.5.0 support, including code samples and migration strategies
  • Updated _meta.json to include the new "Migrate to v7" guide in the documentation navigation

Note

Low Risk
Documentation-only change that adds a new migration guide and updates navigation metadata; no runtime or contract behavior is modified.

Overview
Adds a new migrate-to-v7 documentation page describing the Protocol Kit v7 migration path for Safe v1.5.0, including noted breaking changes (default Safe version bump, moved encodeTransactionData, signature-validation updates, and SafeVersion type extension) plus new v1.5.0 features and deprecations.

Updates pages/sdk/protocol-kit/guides/_meta.json to include the new guide in the docs navigation.

Written by Cursor Bugbot for commit 628ff3e. This will update automatically on new commits. Configure here.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Mar 9, 2026

Branch preview

✅ Deployed successfully in branch deployment:

https://docs_sdk_migration_guide--docs.review.5afe.dev

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Mar 9, 2026

Overall readability score: 36.95 (🟢 +0.09)

File Readability
migrate-to-v7.md 70.6 (-)
View detailed metrics

🟢 - Shows an increase in readability
🔴 - Shows a decrease in readability

File Readability FRE GF ARI CLI DCRS
migrate-to-v7.md 70.6 59.3 8.02 9.8 11.24 6.86
  - - - - - -

Averages:

  Readability FRE GF ARI CLI DCRS
Average 36.95 31.59 13.12 16.3 14.74 8.71
  🟢 +0.09 🟢 +0.07 🟢 +0.01 🟢 +0.02 🟢 +0.01 🟢 +0
View metric targets
Metric Range Ideal score
Flesch Reading Ease 100 (very easy read) to 0 (extremely difficult read) 60
Gunning Fog 6 (very easy read) to 17 (extremely difficult read) 8 or less
Auto. Read. Index 6 (very easy read) to 14 (extremely difficult read) 8 or less
Coleman Liau Index 6 (very easy read) to 17 (extremely difficult read) 8 or less
Dale-Chall Readability 4.9 (very easy read) to 9.9 (extremely difficult read) 6.9 or less

@yagopv yagopv requested a review from dasanra March 9, 2026 15:38
@dasanra dasanra merged commit 5684851 into main Mar 27, 2026
4 checks passed
@dasanra dasanra deleted the docs/sdk-migration-guide branch March 27, 2026 15:56
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.

2 participants