Skip to content
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

Quickstart refactor #1480

Open
wants to merge 22 commits into
base: main
Choose a base branch
from
Open

Quickstart refactor #1480

wants to merge 22 commits into from

Conversation

LandauRaz
Copy link
Collaborator

@LandauRaz LandauRaz commented Jan 14, 2025

Description of the Changes

Refactored the "Quickstart" section.

PR Preview URL

https://starknet-io.github.io/starknet-docs/pr-1480/quick-start/overview/

https://starknet-io.github.io/starknet-docs/pr-1480/quick-start/environment-setup/

https://starknet-io.github.io/starknet-docs/pr-1480/quick-start/compiling-hellostarknet/

https://starknet-io.github.io/starknet-docs/pr-1480/quick-start/devnet/

https://starknet-io.github.io/starknet-docs/pr-1480/quick-start/sepolia/

https://starknet-io.github.io/starknet-docs/pr-1480/quick-start/next-steps/

Check List

  • Changes made against main branch and PR does not conflict
  • PR title is meaningful, e.g: fix: minor typos in README
  • Detailed description added under "Description of the Changes"
  • Specific URL(s) added under "PR Preview URL"

This change is Reviewable

@starknet-bot
Copy link
Collaborator

Oops, your pull request failed to pass the Typo tests stage :( . see the result:
error: evironment should be environment
--> ./components/Starknet/modules/quick-start/pages/environment-setup.adoc:8:255
|
8 | As a popular phrase (often attributed to Abraham Lincoln) says, "Give me six hours to chop down a tree, and I will spend the first four sharpening the axe". The first installment of the series will therefore guide you through setting up your development evironment, which includes the three most recommended tools to begin developing on Starknet:
| ^^^^^^^^^^
|

Please fix the typo, commit and push!

@starknet-bot
Copy link
Collaborator

Oops, your pull request failed to pass the Typo tests stage :( . see the result:
error: evironment should be environment
--> ./components/Starknet/modules/quick-start/pages/environment-setup.adoc:8:255
|
8 | As a popular phrase (often attributed to Abraham Lincoln) says, "Give me six hours to chop down a tree, and I will spend the first four sharpening the axe". The first installment of the series will therefore guide you through setting up your development evironment, which will include the three most recommended tools to begin developing on Starknet:
| ^^^^^^^^^^
|
error: fith should be fifth, filth
--> ./components/Starknet/modules/quick-start/pages/using_devnet.adoc:7:16
|
7 | Welcome to the fith installment of the "Hello, Starknet!" quickstart series, the official tutorial for starting your journey as a Starknet developer! 🚀
| ^^^^
|
error: neccessary should be necessary
--> ./components/Starknet/modules/quick-start/pages/overview.adoc:5:50
|
5 | This tutorial will walk you though all the steps neccessary to deploy your very own HelloStarknet contract, including:
| ^^^^^^^^^^
|
error: enviorment should be environment
--> ./components/Starknet/modules/quick-start/pages/overview.adoc:7:68
|
7 | * xref:environment-setup.adoc[Setting up your Starknet development enviorment]
| ^^^^^^^^^^
|
error: intial should be initial
--> ./components/Starknet/modules/quick-start/pages/deploy-a-smart-contract.adoc:68:234
|
68 | where 0x055adcccc3de77a9d23cd8250965b388179e1ebd6d6be32f5bc6a08a34805e5e is the contract's deployed address. If called before invoking the increase_balance function, the result should resemble the following (since the contract's intial balance is preset to 0):
| ^^^^^^
|
error: invokation should be invocation
--> ./components/Starknet/modules/quick-start/pages/deploy-a-smart-contract.adoc:89:8
|
89 | If the invokation was successful, Starkli's output should resemble the following:
| ^^^^^^^^^^
|

Please fix the typo, commit and push!

@starknet-bot
Copy link
Collaborator

Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1480/ .

@starknet-bot
Copy link
Collaborator

Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1480/ .

1 similar comment
@starknet-bot
Copy link
Collaborator

Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1480/ .

@starknet-bot
Copy link
Collaborator

Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1480/ .

@starknet-bot
Copy link
Collaborator

Oops, your pull request failed to pass the Typo tests stage :( . see the result:
error: successfuly should be successfully
--> ./components/Starknet/modules/quick-start/pages/next-steps.adoc:7:12
|
7 | By now you successfuly declared, deployed, and interacted with the HelloStarknet both on Starknet Sepolia and locally (way to go!). This last installment of the series will therefore only list possible next steps for you to take:
| ^^^^^^^^^^^
|
error: recommeneded should be recommended
--> ./components/Starknet/modules/quick-start/pages/using_devnet.adoc:11:72
|
11 | // Local networks – also known as development networks (devnets) – are recommeneded for a fast and private development process. This installment of the series will therefore guide you through the steps necessary to use Starknet Devnet to declase, deploy, and interact with the HelloStarknet contract locally.
| ^^^^^^^^^^^^
|
error: declase should be declares
--> ./components/Starknet/modules/quick-start/pages/using_devnet.adoc:11:239
|
11 | // Local networks – also known as development networks (devnets) – are recommeneded for a fast and private development process. This installment of the series will therefore guide you through the steps necessary to use Starknet Devnet to declase, deploy, and interact with the HelloStarknet contract locally.
| ^^^^^^^
|
error: fith should be fifth, filth
--> ./components/Starknet/modules/quick-start/pages/deploy-a-smart-contract.adoc:5:16
|
5 | Welcome to the fith installment of the "Hello, Starknet!" quickstart series, the official tutorial for starting your journey as a Starknet developer! 🚀
| ^^^^
|

Please fix the typo, commit and push!

@starknet-bot
Copy link
Collaborator

Oops, your pull request failed to pass the Typo tests stage :( . see the result:
error: successfuly should be successfully
--> ./components/Starknet/modules/quick-start/pages/next-steps.adoc:7:12
|
7 | By now you successfuly declared, deployed, and interacted with the HelloStarknet both on Starknet Sepolia and locally (way to go!). This last installment of the series will therefore only list possible next steps for you to take:
| ^^^^^^^^^^^
|
error: recommeneded should be recommended
--> ./components/Starknet/modules/quick-start/pages/using_devnet.adoc:11:72
|
11 | // Local networks – also known as development networks (devnets) – are recommeneded for a fast and private development process. This installment of the series will therefore guide you through the steps necessary to use Starknet Devnet to declase, deploy, and interact with the HelloStarknet contract locally.
| ^^^^^^^^^^^^
|
error: declase should be declares
--> ./components/Starknet/modules/quick-start/pages/using_devnet.adoc:11:239
|
11 | // Local networks – also known as development networks (devnets) – are recommeneded for a fast and private development process. This installment of the series will therefore guide you through the steps necessary to use Starknet Devnet to declase, deploy, and interact with the HelloStarknet contract locally.
| ^^^^^^^
|

Please fix the typo, commit and push!

@starknet-bot
Copy link
Collaborator

Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1480/ .

@starknet-bot
Copy link
Collaborator

Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1480/ .

1 similar comment
@starknet-bot
Copy link
Collaborator

Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1480/ .

@starknet-bot
Copy link
Collaborator

Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1480/ .

3 similar comments
@starknet-bot
Copy link
Collaborator

Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1480/ .

@starknet-bot
Copy link
Collaborator

Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1480/ .

@starknet-bot
Copy link
Collaborator

Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1480/ .

@starknet-bot
Copy link
Collaborator

Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1480/ .

@starknet-bot
Copy link
Collaborator

Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1480/ .

@starknet-bot
Copy link
Collaborator

Oops, your pull request failed to pass the Typo tests stage :( . see the result:
error: accout should be account
--> ./components/Starknet/modules/quick-start/pages/sepolia.adoc:13:193
|
13 | Similar to interacting with a Starknet Devnet instance, to interact with Starknet Sepolia you first need an account. However, on Sepolia it is often simpler to create and deploy a new Starkli accout rather than fetching a predeployed one. Creating a new Starkli account requires first creating a Starkli signer, which will again be an encrypted keystore signer. To create a new encrypted keystore signer, run:
| ^^^^^^
|

Please fix the typo, commit and push!

@starknet-bot
Copy link
Collaborator

Oops, your pull request failed to pass the Typo tests stage :( . see the result:
error: decalring should be declaring
--> ./components/Starknet/modules/quick-start/pages/compiling-hellostarknet.adoc:7:119
|
7 | Before a contract can be deployed on Starknet, its compiled code needs to be submitted to the network (also known as decalring it). This installment of the series will therefore walk you though compiling Scarb's default HelloStarknet contract, which will be used throughout the following installments.
| ^^^^^^^^^
|

Please fix the typo, commit and push!

@starknet-bot
Copy link
Collaborator

Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1480/ .

1 similar comment
@starknet-bot
Copy link
Collaborator

Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1480/ .

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants