Outdated documentation and missing example material to onboard devs

[dasanra]

Part 1: Define the problem

What problem are you trying to solve?

We are planning to present a workshop during DappCon to showcase how to create tools for the Safe using the Safe Apps SDK. Currently there is not enough example materials and we would need some time to prepare this before we are ready to onboard users.

What is your hypothesis?

The Safe Apps team should work in order to enable an easy onboarding of new developers so they are able to create or adapt Safe Apps. This will make the Safe ecosystem to grow with new tools and integrations. However currently we don't have many example resources, some material is not well organized and also docs are not updated with the latest changes. If we improve our example and guide material, developers experience will improve.

What value does this bring to our customer and/or our mission? What is the goal?

If we make easy for developers to reach the docs and current Safe Apps SDK tooling we will make the Safe ecosystem to grow. Many developers have troubles integrating the SDK as many Safe Apps don't work as expected in the first integration. Also we are not seeing lots of community proposals for basic tooling of the Safe.

During EthCC I got the feedback that docs are not currently easy to find or follow, so definitely something we should improve if we want to attract more developers.

How do we measure it?

Links:

// Include useful research, such as user tests, competitive analysis, metrics, or surveys.

Part 2: Shaping the problem

Problem Owner

Daniel So

Non Goal(s)

// Controlling the scope of solving the problem.

Solution

Solution 1

Overview
Our proposed solution will cover different areas of developer tools. We need to check that all safe-apps-sdk docs are up to date and pointing to the correct references, we will also create a functional example Safe App, and review/updating some already existing the CRA template, QA/testing Safe App review, and update help docs either in gitbook and intercom help center. We should also create a presentation to use in public events to show how to use the Safe Apps developer tooling.

Rough Scoping & Timeline

We expect to need around 2 weeks of this roadmap cycle to prepare everything. In terms of development is not a complex task, but we need to review and correct link many resources.

• Create an example Safe App with basic functionallity that could be use as step by step tutorial
  • Show onboard.js use to integrate Safe Apps in already existing projects
  • Show direct Safe integration using the SDK (Safe focused Safe Apps)
• Create small faucet to give out testing tokens so participants can create a new Safe on a cheaper chain/testnet
• Update help intercom docs. Also take some time to renew screenshots with up to date styling
• Review gitbook information. Add missing elements from safe-apps-sdk (wagmi connector) or remove old unused ones
• Create slideshow presentation to show example in public.
• Update testing/QA app as an example Safe App
• Update CRA template and docs.

Risk(s), Key Trade Offs & Decisions

This is a tedious problem statement, as it involves lot of resources, some of them that were left a bit behind. Documentation is important but still is easy to be left behind. We should use this opportunity to update and improve the docs so more devs can start with a better feeling about the Safe

Open Questions