Skip to content

Commit

Permalink
Merge branch 'master' into stylus-section-rename-gentle-intro
Browse files Browse the repository at this point in the history
  • Loading branch information
pete-vielhaber committed Dec 11, 2024
2 parents f1274c3 + 8b5cb6d commit ef93b6b
Show file tree
Hide file tree
Showing 11 changed files with 73 additions and 31 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ content_type: quickstart

:::info Want to use Rust instead?

Head over to [the Stylus quickstart](/stylus/stylus-quickstart) if you'd like to use Rust instead of Solidity.
Head over to [the Stylus quickstart](/stylus/quickstart) if you'd like to use Rust instead of Solidity.

:::

Expand Down
2 changes: 1 addition & 1 deletion arbitrum-docs/partials/_troubleshooting-stylus-partial.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ You deploy a Stylus contract the same way that Solidity contracts are deployed.
</p>

<p>
You can find instructions for deploying a Stylus contract in our <a href="https://docs.arbitrum.io/stylus/stylus-quickstart#checking-your-stylus-project-is-valid">Quickstart</a>.
You can find instructions for deploying a Stylus contract in our <a href="https://docs.arbitrum.io/stylus/quickstart#checking-your-stylus-project-is-valid">Quickstart</a>.
</p>


Expand Down
2 changes: 0 additions & 2 deletions arbitrum-docs/stylus/cli-tools-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@ title: CLI Tools (cargo-stylus)
sidebar_label: CLI tools overview
---

# CLI tools (cargo-stylus)

The CLI tools provided for Stylus, specifically the `cargo-stylus` tool, are designed to help developers manage, compile, and optimize their Stylus contracts efficiently. This overview provides a summary of the tools available and how to use them effectively.

## Available tools
Expand Down
4 changes: 2 additions & 2 deletions arbitrum-docs/stylus/gentle-introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ sidebar_position: 1

### In a nutshell:

- Stylus lets you write smart contracts in programming languages that compile to WASM, such as **Rust, C, C++, and many others**, allowing you to tap into their ecosystem of libraries and tools. Rich language and tooling support already exist for Rust. You can try the SDK and CLI with the [quickstart](https://docs.arbitrum.io/stylus/stylus-quickstart).
- Stylus lets you write smart contracts in programming languages that compile to WASM, such as **Rust, C, C++, and many others**, allowing you to tap into their ecosystem of libraries and tools. Rich language and tooling support already exist for Rust. You can try the SDK and CLI with the [quickstart](https://docs.arbitrum.io/stylus/quickstart).
- Solidity contracts and Stylus contracts are <b>fully interoperable</b>. In Solidity, you can call a Rust program and vice versa, thanks to a second, coequal WASM virtual machine.
- Stylus contracts offer significantly <b>faster execution and lower gas fees </b> for memory and compute-intensive operations, thanks to the superior efficiency of <a data-quicklook-from="wasm">WASM</a> programs.

Expand Down Expand Up @@ -45,7 +45,7 @@ While many developers will be drawn to new use cases, rebuilding existing applic

### Getting Started

1. Utilize our [quickstart](https://docs.arbitrum.io/stylus/stylus-quickstart), [Rust SDK](https://docs.arbitrum.io/stylus/reference/overview), to help you start building.
1. Utilize our [quickstart](https://docs.arbitrum.io/stylus/quickstart), [Rust SDK](https://docs.arbitrum.io/stylus/reference/overview), to help you start building.
2. Join our Stylus Developer [Telegram](https://t.me/arbitrum_stylus) group and [Arbitrum Discord](https://discord.gg/arbitrum) for support as well as the official Arbitrum ([@Arbitrum](https://twitter.com/arbitrum)) and Arbitrum Developers ([@ArbitrumDevs](https://twitter.com/ArbitrumDevs)) X accounts for announcements.
3. Check out the [Awesome Stylus](https://github.com/OffchainLabs/awesome-stylus) repository for various community contributed Stylus projects and tools. If you build something useful, we'd be happy to add it there.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Let's learn how to write contracts with Stylus!
<Card
title="Quickstart (Rust)"
description="Get started quickly with Rust."
href="https://docs.arbitrum.io/stylus/stylus-quickstart"
href="https://docs.arbitrum.io/stylus/quickstart"
/>
<Card
title="Testnet"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
id: stylus-quickstart
id: quickstart
title: 'Quickstart: write a smart contract in Rust using Stylus'
description: 'Leads a developer from 0 to 1 writing and deploying a smart contract in Rust using Stylus'
author: chrisco512, anegg0
Expand All @@ -10,13 +10,13 @@ target_audience: Developers writing Stylus contracts in Rust using Stylus

This guide will get you started with <a data-quicklook-from="stylus">Stylus</a>' basics. We'll cover the following steps:

1. [Setting up your development environment](./stylus-quickstart#setting-up-your-development-environment)
2. [Creating a Stylus project with cargo stylus](./stylus-quickstart#creating-a-stylus-project-with-cargo-stylus)
3. [Checking the validity of your contract](./stylus-quickstart#checking-if-your-stylus-project-is-valid)
4. [Deploying your contract](./stylus-quickstart#deploying-your-contract)
1. [Setting up your development environment](./quickstart#setting-up-your-development-environment)
2. [Creating a Stylus project with cargo stylus](./quickstart#creating-a-stylus-project-with-cargo-stylus)
3. [Checking the validity of your contract](./quickstart#checking-if-your-stylus-project-is-valid)
4. [Deploying your contract](./quickstart#deploying-your-contract)
5. [Exporting your contract's ABIs](#exporting-the-solidity-abi-interface)
6. [Calling your contract](./stylus-quickstart#calling-your-contract)
7. [Sending a transaction to your contract](./stylus-quickstart#sending-a-transaction-to-your-contract)
6. [Calling your contract](./quickstart#calling-your-contract)
7. [Sending a transaction to your contract](./quickstart#sending-a-transaction-to-your-contract)

## Setting up your development environment

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
id: using-stylus-cli
id: using-cli
title: 'Using Stylus CLI'
description: 'Get started with Stylus CLI, a Rust toolkit for developing Stylus contracts'
author: 'anegg0'
Expand Down
2 changes: 1 addition & 1 deletion arbitrum-docs/welcome/get-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ The Arbitrum suite includes the protocols, chains, services, and SDKs that power
| ------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
| [A gentle introduction to Arbitrum](/welcome/arbitrum-gentle-introduction) | A technical introduction to Arbitrum's suite of scaling solutions. |
| [Quickstart (Solidity)](/build-decentralized-apps/01-quickstart-solidity-hardhat.mdx) | Targeted at web2 developers who want to deploy their first Solidity smart contract to Arbitrum. |
| [Quickstart (Rust)](/stylus/stylus-quickstart) | Targeted at web3 developers who want to deploy their first Rust smart contract to Arbitrum using Stylus. |
| [Quickstart (Rust)](/stylus/quickstart) | Targeted at web3 developers who want to deploy their first Rust smart contract to Arbitrum using Stylus. |

## Arbitrum for node runners

Expand Down
4 changes: 2 additions & 2 deletions website/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -505,7 +505,7 @@ const sidebars = {
},
{
type: 'doc',
id: 'stylus/stylus-quickstart',
id: 'stylus/quickstart',
label: 'Quickstart',
},
{
Expand Down Expand Up @@ -533,7 +533,7 @@ const sidebars = {
items: [
{
type: 'doc',
id: 'stylus/using-stylus-cli',
id: 'stylus/using-cli',
label: 'Overview',
},
{
Expand Down
2 changes: 1 addition & 1 deletion website/src/components/HomepageFeatures/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ const FeatureList: FeatureItem[] = [
{
title: 'Quickstart: Stylus',
Svg: require('@site/static/img/stylus-logo.svg').default,
href: '/stylus/stylus-quickstart',
href: '/stylus/quickstart',
description: 'Use Stylus to write an EVM-compatible smart contract in Rust.',
},
{
Expand Down
Loading

0 comments on commit ef93b6b

Please sign in to comment.