Create a Quickstart guide Template and Quickstart Section for the Safe Core SDK #163
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
ademidun
changed the title
TODO: add more
ademidun
changed the title
rmeissner
reviewed
Feb 22, 2023
We already have this information here: https://github.com/safe-global/safe-core-sdk/blob/main/guides/integrating-the-safe-core-sdk.md
germartinez
requested changes
Feb 23, 2023
There was a problem hiding this comment.
Please, review some comments regarding a few little inconsistencies
- Remove all semicolons (some lines contain semicolons, others don't)
- Start all comments in the code with uppercase (some comments start with uppercase and some lowercase)
- Some titles have all their words starting with uppercase, some have just the first word.
- Only use single quotes (some strings have double and others have single quotes)
- Review code indentations and only use two spaces
We should not base our tutorials/guides on content created outside of our team, as they will probably not be up to date and will be more difficult to spot possible errors (using deprecated interfaces, parameters, etc.). It would be good, as a final test, if you could try the code and make sure it works properly.
germartinez
reviewed
Feb 23, 2023
|
It's probably useful to point to the Safe Core SDK API Reference as well when linking to the detailed guide |
Co-authored-by: Germán Martínez <6764315+germartinez@users.noreply.github.com>
Co-authored-by: Germán Martínez <6764315+germartinez@users.noreply.github.com>
|
Closed by #165 |
8 tasks
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.
This PR has been moved to #165
This PR was created before I had write access to this repo.
This PR introduces a standard template that all quickstart docs should follow as part of the Developer Docs Status Update: 2023-02-22.
The goal of each quickstart is to provide the "minimum viable code" that a developer needs to complete a task using a given package or library. Any additional functionality can go into a separate "Detailed Guide" doc as seen in this example: Guide: Integrating the Safe Core SDK.
This quickstart shows the "minimum viable code" needed to create a Safe and propose and execute a multi-sig transaction using the Safe Core SDK.
Each quick start guide should include the following:
Style Guide
Project Management