Add legacy safe-core-sdk migration guide
#291
Merged
Conversation
This file contains 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
update api-kit initialization update createTransaction use
Co-authored-by: Tanay Pant <[email protected]>
Co-authored-by: Tanay Pant <[email protected]>
|
Overall readability score: 70.99 (🟢 +0.14)
View detailed metrics🟢 - Shows an increase in readability
Averages:
View metric targets
|
tanay1337
requested changes
Nov 29, 2023
| @@ -0,0 +1,114 @@ | |||
| # API Kit: Migrating from `safe-service-client` | |||
There was a problem hiding this comment.
Should the title be Migrating to v1 for consistency with the other migration guide?
There was a problem hiding this comment.
In the other migration guide we set API Kit: Migrating from v1. The Migrating to v2 was set as the Link title in SUMMARY.md.
Should I align the titles or should I leave it like this?
There was a problem hiding this comment.
I think both the link title and the title were the same: https://docs.safe.global/safe-core-aa-sdk/api-kit/reference/v2.
There was a problem hiding this comment.
It seems gitdocs is ignoring the H1 element # in the file and overwritting with what you write in the SUMMARY file
There was a problem hiding this comment.
Ah, I see. Interesting. I am fine if you so it same as you did for the last one by changing it in the Summary file :)
There was a problem hiding this comment.
Yes, for the visuals in the menu Migrating to v1 feels more correct, I'm just concerned because this migration also involved a package name change:
safe-core-sdk + safe-ethers-lib + safe-web3-lib -> protocol-kit
safe-service-client -> safe-api-kit
We can test this way and re-evaluate if people is having trouble finding it.
There was a problem hiding this comment.
Should this be added as a page description or somewhere in the text so that it appears when people search from the search bar? 👀
There was a problem hiding this comment.
Will think about it
Co-authored-by: Tanay Pant <[email protected]>
tanay1337
reviewed
Nov 29, 2023
SUMMARY.md
Outdated
| @@ -34,6 +34,7 @@ | |||
|
|
|||
| * [Protocol Kit](safe-core-sdk/protocol-kit/README.md) | |||
| * [Reference](safe-core-sdk/protocol-kit/reference/README.md) | |||
| * [Migrating to v1](safe-core-sdk/protocol-kit/reference/migrating/v1.md) | |||
There was a problem hiding this comment.
The last question, we should probably switch the order. WDYT?
There was a problem hiding this comment.
With only 2 versions people wouldn't get lost, but I think I get your point.
Will do it 👍
Co-authored-by: Tanay Pant <[email protected]>
tanay1337
approved these changes
Nov 29, 2023
louis-md
added a commit
that referenced
this pull request
Dec 19, 2023
louis-md
added a commit
that referenced
this pull request
Jan 24, 2024
* Update SUMMARY.md (#251) * Update SUMMARY.md * Update SUMMARY.md * Add GH action for readability (#254) Co-authored-by: Tanay Pant <tanaypantprotonmail.com> * Add workflow for style check on PRs (#255) Co-authored-by: Tanay Pant <tanaypantprotonmail.com> * Update workflow setting * Add link check workflow (#257) * Add link check workflow * Fix errors --------- Co-authored-by: Tanay Pant <tanaypantprotonmail.com> * Remove link check GH action * Link check workflow (#259) * Link check workflow * Test a fix * Updates * Fixes --------- Co-authored-by: Tanay Pant <tanaypantprotonmail.com> * Add weekly link checker (#260) * Add weekly link checker * Minor updates --------- Co-authored-by: Tanay Pant <tanaypantprotonmail.com> * Add manual trigger for testing * Fix conditional for issue creation * Update conditional for workflow * Minor updates to the workflow * Update information architecture (#265) * Update information architecture * Update minimum alert level for Vale * Remove unused files --------- Co-authored-by: Tanay Pant <tanaypantprotonmail.com> * Update Safe Apps section (#267) * Update Safe Docs * Update README.md * Add new vocabulary * Update README.md * Update get-started.md * Update get-started.md * Add new vocab * Update release.md * Update release.md * Add new vocab * New words * Update release.md * Update release.md * Update safe-apps/release.md Co-authored-by: Germán Martínez <[email protected]> * Update safe-apps/release.md Co-authored-by: Germán Martínez <[email protected]> * Update safe-apps/release.md Co-authored-by: Germán Martínez <[email protected]> --------- Co-authored-by: Tanay Pant <tanaypantprotonmail.com> Co-authored-by: Germán Martínez <[email protected]> * Update IA for reference (#268) * Update IA * Fixes * Move files around * Update SUMMARY.md --------- Co-authored-by: Tanay Pant <tanaypantprotonmail.com> * docs: fix typos (#271) * docs: fix typos * Update safe-apps/release.md revert typo walkthroughts Co-authored-by: Germán Martínez <[email protected]> * Update safe-core-api/rpc-requirements.md fix typos Co-authored-by: Germán Martínez <[email protected]> * Update safe-core-api/rpc-requirements.md Co-authored-by: Germán Martínez <[email protected]> * Update safe-core-api/rpc-requirements.md Co-authored-by: Germán Martínez <[email protected]> * Update safe-core-api/rpc-requirements.md fix typos Co-authored-by: Germán Martínez <[email protected]> * Update safe-apps/release.md fix typo Co-authored-by: Germán Martínez <[email protected]> --------- Co-authored-by: Germán Martínez <[email protected]> * fix: update `@web3auth/*` versions (#270) * fix: update `@web3auth/*` versions * fix: revert formatting * Update README.md (#276) * Add script to generate Supported Networks pages from safe-deployments repo as a github action (#278) * Add script to genereate Supported Networks pages from safe-deployments repo as a github action * Update summary * Update summary * Fix typo in supported networks script & re-generate .md files * Implement requested changes * Implement requested changes * Remove unused console.log; fix supported networks index page & block explorers * Fix some vale errors ("networks's" & "Testnet") * Re-generate supported networks * Implement requested changes (wording & correct section) * Update SUMMARY.md * Update SUMMARY.md * Update SUMMARY.md * Update SUMMARY.md * Update SUMMARY.md * Move supported networks .md folder into safe-smart-accounts * Implement requested changes (create PR on workflow, minor fixes) * Update vale dictionnary * Update vale dictionnary * Remove duplicates in vale dictionnary * Remove unnecessary steps in github workflow for supported networks * Remove duplicates in vale dictionnary * Alphabetize & deduplicate vale dictionnary * Exclude deprecated block explorer from supported networks page generation --------- Co-authored-by: Germán Martínez <[email protected]> * Link checks (#275) * Fix some link checker errors * Fix some link checker errors * Fix some link checker errors * Add Pimlico to Safe Modules (#279) * Update modules.md * Update accept.txt * Update weekly-link-check.yml (#281) * Revert "Update weekly-link-check.yml (#281)" (#283) This reverts commit 4d2f19d. * Link fixes (#284) * Update README.md * Update MoneriumPack.md * Link checks (#285) * Fix some link checker errors * Fix some link checker errors * Fix some link checker errors * Fix broken links * Re-generate .md files * protocol-kit v2.0 (#266) * update ethers docs * add singleton change to api-kit and protocol-kit update api-kit initialization update createTransaction use * update GelatoRelayKit breaking changes * fix wording recommendations * highlight ethers.js v6 * add migration guides highlighting the major changes --------- Co-authored-by: Daniel <[email protected]> * Switch from gitbook to nextra * Migrate getting started section * Migrate assets * Migrate misc section * Migrate safe-apps section * Migrate safe-core-api section * Migrate safe-core-sdk section * Migrate safe-smart-account section * Migrate safe-core-protocol section * Add index page * Update generate supported network script * Fix broken links & vale errors * Fix vale errors * Fix vale errors * Fix vale errors * Reorder sidebar (#292) * Update SUMMARY.md * Update and rename available-services.md to supported-networks.md * Implement design feedback (color palette, font) * Add torusscan as a deprecated block explorer in generateSupportedNetworks * Add footer from safe.global * Remove Home component; redirect index to first page * Implement design feedback (navbar background color & backdrop filter) * Add legacy `safe-core-sdk` migration guide (#291) * update ethers docs * add singleton change to api-kit and protocol-kit update api-kit initialization update createTransaction use * Fix linting and typos * fix: broken links * update GelatoRelayKit breaking changes * improve parameter naming * fix linter reported issue * fix wording recommendations * highlight ethers.js v6 * add migration guides highlighting the major changes * fix typos * Apply suggestions from code review Co-authored-by: Tanay Pant <[email protected]> * add backticks to EthersAdapter * Apply suggestions from code review Co-authored-by: Tanay Pant <[email protected]> * set migrating guides below reference * add wording suggestions * Add safe-transaction-service migration guide * Add migration guide from legacy safe-core-sdk * Add types changes * remove auth-kit changes * fix linting issues * improve api-kit v2 migration * Add latest changes * Add missing type * fix typo * Apply suggestions from code review Co-authored-by: Tanay Pant <[email protected]> * add migration links * Update safe-core-sdk/protocol-kit/reference/migrating/v1.md Co-authored-by: Tanay Pant <[email protected]> * Reverse migration links order in SUMMARY --------- Co-authored-by: Daniel Somoza <[email protected]> Co-authored-by: Tanay Pant <[email protected]> * Add middleware information for Safe Apps (#293) * Update get-started.md * Update accept.txt * Fix information architecture * Fix error in code snippet (#295) * Fix all images & callouts * Collapse sidebar menu items * Add deployment workflow * Fix deployment workflow * Fix deployment workflow * Fix deployment workflow * docs(auth-kit): Update docs for the new `SafeAuthPack` (#289) * add protocol-kit v2 updates * Add SafeAuth information * Update ethersv6 changes * Fix deployment workflow * Fix deployment workflow * Fix deployment workflow * fix broken links (#296) * fix broken links * fix: link name * Minor fixes * chore: Improve auth-kit docs (#298) * Fix broken links * Force dark theme * Fix generate supported networks * Add avax.boba.network as deprecated block explorers * Fix generate supported networks (#299) * Fix generate supported networks * Generate supported networks .md files * Edit vocab * Add toruscan as deprecated block explorer * Add favicon; fix theme color. * Cherry pick merged changes from #289 * Cherry pick merged changes from #291 * Cherry pick merged changes from subsequent PRs * Fix link checker & vale errors * Add eslint, standard, husky * Fix lint errors * Fix pre-push commit hook * Fix theme import * Set Google Form for first Safe App review contact (#303) * Feedback widget design. WIP logic * Add google analytics * Move contact-us links in footer * Rename all files with prefixes * Add local link checker to prepush hook * Minor fix * Fix vale config * Add missing content from `main` * Add redirections from gitbook paths * Fix eslint config * Remove linkchecker from prepush hook * Add legacy redirects * Custom 404 page * Fix breaking changes in vale v3 * fix: link view inside hint element not showing as expected (#307) * Restore signature files (#308) * Restore signatures * Fix link * Fix conflicts with signatures * Update gitignore * Fix Vale errors * Accept words with Vale * Fix vale errors; add vale to lint command. * Fix build * Fix redirect link * Implement requested changes * Add redirections test * Fix tsconfig * Fix typos in redirects * Fix typo in redirects * Switch all routes to kebab-case --------- Co-authored-by: Tanay Pant <[email protected]> Co-authored-by: Tanay Pant <tanaypantprotonmail.com> Co-authored-by: Germán Martínez <[email protected]> Co-authored-by: xiaolou86 <[email protected]> Co-authored-by: Aaron Cook <[email protected]> Co-authored-by: Dani Somoza <[email protected]> Co-authored-by: Daniel <[email protected]> Co-authored-by: Daniel Somoza <[email protected]> Co-authored-by: Pran <[email protected]> Co-authored-by: Yago Pérez Vázquez <[email protected]> Co-authored-by: Germán Martínez <[email protected]>
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.
Overview
We plan to mark the legacy
safe-core-sdkas deprecated onnpm. There weren't many breaking changes betweensafe-core-sdkand theprotocol-kit v1release but we want to provide a few migration materials that can be used as reference when existing integrations want to migrate to the new kits structure.