Skip to content

[DOCS] Quickstart guide for Superchain Interop env #1644

Open
@Nicca42

Description

@Nicca42

Description

A hand holding/spoon feeding guide on:

  1. TLDR what is the superchain and what interop means for your app (why should an app dev care about interop?)
  2. Walking through each of the tools and why you need them
    • SuperCLI -> lets you easily manage multichain deployments
    • Supersim -> local interop testnet env for testing
    • devnet -> testnet for interop testing
    • etc
  3. Walk through the SuperchainERC20 repo, explaining why each of the deviations from the base standard where made, with the goal of giving the devs a solid understanding of the design shifts they need to think about when designing for interop. This might be easier to do with the tic-tac-toe example, but ideally the repo we use here is one that is likely to be maintained.
  4. Walk through env set up, deploying a SuperERC20 on a local env, then devnet.

Acceptance criteria

  • Builds up context from 0 (assuming EVM blockchain development understanding)
    • What is the Superchain?
    • What is superchain interop?
    • Why is it good for my app?
  • Clearly explains the design considerations for interop
  • Hand holds the reader through using each of the interop tools

User stories

Users are struggling to find and use the tooling we have built. If we have a better self paced guide devs are more likely to come away with the critical context needed to build interop ready apps.

Resources and support

Right now we have many users asking about the various parts/tools, and needing to go to multiple resources to get all the answers. By having one, spoon feeding guide we can answer all these questions while providing important design context, and some "why you should care" which is missing from docs.

This is still beneficial even for power devs, as they can skim through the guide to get what they need. For non-power devs, this is a major unlock in understanding.

Image

Action items

  • Ideally we get the techNERDs to review the PR before it goes live, as they (better than anyone) understand what the devs are missing in understanding and context.

Metadata

Metadata

Assignees

Labels

community-requestdocs updates requested by community or OP collectivedocumentationImprovements or additions to documentation

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions