Skip to content

Add video tutorial + Atlas to docs #117

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from

Conversation

sameesiddiqui
Copy link

Description

Adding video tutorial for new developers that walks through metamask setup, getting testnet eth, bridging to sepolia, and deploying.

Also adds deploy instructions using Atlas

Changes

Developer quickstart and contract deployment tutorial

Copy link

netlify bot commented Nov 4, 2023

Deploy Preview for scroll-documentation ready!

Name Link
🔨 Latest commit ebe7aaa
🔍 Latest deploy log https://app.netlify.com/sites/scroll-documentation/deploys/6545bc849550840008ab156d
😎 Deploy Preview https://deploy-preview-117.docs.scroll.xyz
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Contributor

@dghelm dghelm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for taking the time to raise this PR. Made comments throughout since these are style choices for our documentation. Please understand that we highly value conciseness and can't provide space for similar tooling providers and ecosystem products to have space in the docs without it compromising the value they bring to developers and users.

@@ -26,7 +26,9 @@ Scroll uses ETH as its native currency, which will be needed to pay transaction

To start building on Scroll, we suggest you begin with using our Scroll Sepolia testnet. You'll first need to acquire some testnet ETH. See the [Faucet](/user-guide/faucet) page for tips on getting test tokens on Sepolia. After this, you can bridge your testnet ETH to the Scroll Sepolia Testnet (Layer 2) using our [Sepolia Bridge](https://sepolia.scroll.io/bridge), as described in the [Bridge article](/user-guide/bridge).

For a walkthrough, start with the User Guide's [Setup](/user-guide/setup) page.
For a walkthrough, start with the User Guide's [Setup](/user-guide/setup) page. We also have a full video tutorial of setting up Metamask, getting testnet tokens, bridging to Scroll, and deploying below.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since this is a quickstart, we don't want to introduce information that slows down developers needing to use this as a reference. Videos will be better suited for other areas of the documentation or external guides we link to in an upcoming section..

2. Go to the top right and change the network to Scroll
3. Press Deploy

That's it!
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please remove. Our writing style is to remain neutral and avoid language that leans toward marketing, especially in articles that lean toward "reference material".


1. Go to https://app.atlaszk.com
2. Go to the top right and change the network to Scroll
3. Press Deploy
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Following these instructions does not activate the deploy button for me.

image

@@ -10,7 +10,7 @@ whatsnext: { "Scroll Messenger Cross-chain Interaction": "/developers/guides/scr

import Aside from "../../../../../components/Aside.astro"

The Scroll Sepolia Testnet allows anyone to deploy a smart contract on Scroll. In this tutorial, you will learn how to deploy a contract on Scroll Sepolia using common tools for developing on Ethereum. This [demo repo](https://github.com/scroll-tech/scroll-guides/tree/main/contract-deploy-demo) illustrates contract deployment with [Hardhat](https://hardhat.org/) and [Foundry](https://github.com/foundry-rs/foundry).
The Scroll Sepolia Testnet allows anyone to deploy a smart contract on Scroll. In this tutorial, you will learn how to deploy a contract on Scroll Sepolia using common tools for developing on Ethereum. This [demo repo](https://github.com/scroll-tech/scroll-guides/tree/main/contract-deploy-demo) illustrates contract deployment with [Hardhat](https://hardhat.org/) and [Foundry](https://github.com/foundry-rs/foundry). We also have a [video tutorial](https://www.youtube.com/embed/Kdg-n298HuQ?si=j3ml3xkI3iYL5Qpt) for deploying with [Atlas](https://app.atlaszk.com).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unclear who "We" is, and this video isn't following the tutorial so it's breaking up the content. Could be presented as an alternative at the end of the tutorial or as "Additional Resources"

@@ -19,6 +19,13 @@ The Scroll Sepolia Testnet allows anyone to deploy a smart contract on Scroll. I
guides for help.
</Aside>

## Deploy contracts with Atlas
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also breaks up this guide/tutorial without adding anything that actually brings value to the user. A section for alternatives, explaining that online IDEs work out of the box, then specifically linking Remix and Atlas (and providing a video on Atlas) seems like a more viable path forward here.

@dghelm dghelm added the documentation Improvements or additions to documentation label Apr 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants