Skip to content
This repository has been archived by the owner on Aug 21, 2024. It is now read-only.

[Stellar Merge] Redirects and changes for the new "Smart Contracts" section #778

Merged
merged 12 commits into from
Mar 27, 2024
Merged
30 changes: 6 additions & 24 deletions docs/README.mdx
Original file line number Diff line number Diff line change
@@ -1,32 +1,14 @@
---
sidebar_position: 10
title: Welcome
title: We've Moved!
---

Soroban is a smart contracts platform designed to be sensible, built-to-scale, batteries-included, and developer-friendly.
All of our documentation content previously available at `soroban.stellar.org` has now been merged into one, consolidated collection available in the [Stellar Developers Documentation](https://developers.stellar.org). Redirects from this site are in-place, and links have been updated everywhere we've found them.

:::success Validated!
If you have any issues finding the content you're looking for, please give our [docs search](https://developers.stellar.org/search) a try. If you still have trouble, we welcome all feedback, issues, and pull requests in the [stellar-docs GitHub repo](https://github.com/stellar/stellar-docs).

On Tuesday, February 20, 2024 the validators of the Stellar network voted to upgrade Mainnet to Protocol version 20, marking the dawn of a new era for the Stellar network. The Soroban platform is now running and the [phased rollout] has begun!
:::info There is one temporary exception...

:::

While it works well with Stellar, a blockchain that shares its values of scale and sensibility, it doesn't depend on or require Stellar at all, and can be used by any transaction processor, including other blockchains, L2s, and permissioned ledgers.

Soroban was introduced to the Stellar Mainnet as a part of protocol version 20. The Soroban platform includes the smart contracts environment, a Rust SDK, A CLI, and an RPC server. Developers can write and test contracts on their local machine, or deploy them to Testnet, or deploy them to Mainnet (keep in mind the resource constraints of the [phased rollout]).

## What this means for the future

We've been releasing very early versions of Soroban since the earliest days of its existence. We have moved on from having "preview releases" and "release candidates" and a "stable relase" and the platform is now **live on Mainnet**! New development efforts are now targeted to a future protocol version, and the current release has been "frozen."

We still believe it's important to share the development process, and we want Stellar ecosystem developers and smart contract developers from other ecosystems to continue experimenting and we continue listening for feedback. Please keep testing it out, see what you can do, and let us know what you think.
The [Soroban Dapps Challenge](/dapps) remains here, for a brief time. There are some version mismatches we're working through, and that section will also be folded into the collection at `developers.stellar.org` soon.

## How to leave feedback

Please feel free to file issues in the Soroban repos, or, if you prefer, to raise them in the `soroban` channels in the [Stellar Developer Discord](https://discord.gg/sp8zfb4qH6).

## Why it's called Soroban

The Japanese soroban is the smallest and simplest abacus. Its design is intentionally compact and minimalist, focused on doing the essentials — and doing them well. It set the global standard for abacuses and is still in practical use today. The name aligns with the goals of this platform because we, too, want to build something that focuses on doing the essentials well, that sets a global standard, and that proves useful far into the future.

[phased rollout]: https://stellar.org/blog/developers/the-stellar-network-s-phased-rollout-of-smart-contracts-the-road-to-mainnet
:::
10 changes: 10 additions & 0 deletions docs/faq.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,18 @@
sidebar_position: 80
title: FAQs
description: Frequently asked questions about Soroban on Stellar.
sidebar_custom_props:
migration:
href: https://developers.stellar.org/docs/learn/smart-contract-internals/faq
label: FAQs
---

:::danger These are not the droids you're looking for

This page has been migrated to the Stellar Developers documentation. Please [click here](https://developers.stellar.org/docs/learn/smart-contract-internals/faq) for the most up-to-date information

:::

<head>
<title>Frequently asked questions about Soroban on Stellar.</title>
<meta charSet="utf-8" />
Expand Down
10 changes: 10 additions & 0 deletions docs/getting-started/create-an-app.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,18 @@
sidebar_position: 50
title: 5. Create an App
description: Make a frontend web app that interacts with your smart contracts.
sidebar_custom_props:
migration:
href: https://developers.stellar.org/docs/smart-contracts/getting-started/create-an-app
label: 5. Create an App
---

:::danger These are not the droids you're looking for

This page has been migrated to the Stellar Developers documentation. Please [click here](https://developers.stellar.org/docs/smart-contracts/getting-started/create-an-app) for the most up-to-date information

:::

With two smart contracts deployed to a public network, you can now create a web app that interacts with them via RPC calls. Let's get started.

## Initialize a frontend toolchain
Expand Down
10 changes: 10 additions & 0 deletions docs/getting-started/deploy-increment-contract.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,18 @@
sidebar_position: 40
title: 4. Deploy the Increment Contract
description: Deploy the Increment contract to Testnet.
sidebar_custom_props:
migration:
href: https://developers.stellar.org/docs/smart-contracts/getting-started/deploy-increment-contract
label: 4. Deploy the Increment Contract
---

:::danger These are not the droids you're looking for

This page has been migrated to the Stellar Developers documentation. Please [click here](https://developers.stellar.org/docs/smart-contracts/getting-started/deploy-increment-contract) for the most up-to-date information

:::

<head>
<meta charSet="utf-8" />
<meta
Expand Down
10 changes: 10 additions & 0 deletions docs/getting-started/deploy-to-testnet.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,18 @@
sidebar_position: 20
title: 2. Deploy to Testnet
description: Deploy a smart contract to a live test network.
sidebar_custom_props:
migration:
href: https://developers.stellar.org/docs/smart-contracts/getting-started/deploy-to-testnet
label: 2. Deploy to Testnet
---

:::danger These are not the droids you're looking for

This page has been migrated to the Stellar Developers documentation. Please [click here](https://developers.stellar.org/docs/smart-contracts/getting-started/deploy-to-testnet) for the most up-to-date information

:::

<head>
<meta charSet="utf-8" />
<meta
Expand Down
10 changes: 10 additions & 0 deletions docs/getting-started/hello-world.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,18 @@
sidebar_position: 10
title: 1. Hello World
description: Create your first smart contract in Rust.
sidebar_custom_props:
migration:
href: https://developers.stellar.org/docs/smart-contracts/getting-started/hello-world
label: 1. Hello World
---

:::danger These are not the droids you're looking for

This page has been migrated to the Stellar Developers documentation. Please [click here](https://developers.stellar.org/docs/smart-contracts/getting-started/hello-world) for the most up-to-date information

:::

<head>
<meta charSet="utf-8" />
<meta
Expand Down
10 changes: 10 additions & 0 deletions docs/getting-started/setup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,18 @@
sidebar_position: 0
title: Setup
description: Install and configure Rust to deploy smart contracts.
sidebar_custom_props:
migration:
href: https://developers.stellar.org/docs/smart-contracts/getting-started/setup
label: Setup
---

:::danger These are not the droids you're looking for

This page has been migrated to the Stellar Developers documentation. Please [click here](https://developers.stellar.org/docs/smart-contracts/getting-started/setup) for the most up-to-date information

:::

<head>
<title>Install and configure Rust to deploy smart contracts.</title>
<meta charSet="utf-8" />
Expand Down
10 changes: 10 additions & 0 deletions docs/getting-started/storing-data.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,18 @@
sidebar_position: 30
title: 3. Storing Data
description: Write a smart contract that stores and retrieves data.
sidebar_custom_props:
migration:
href: https://developers.stellar.org/docs/smart-contracts/getting-started/storing-data
label: 3. Storing Data
---

:::danger These are not the droids you're looking for

This page has been migrated to the Stellar Developers documentation. Please [click here](https://developers.stellar.org/docs/smart-contracts/getting-started/storing-data) for the most up-to-date information

:::

<head>
<meta charSet="utf-8" />
<meta
Expand Down
10 changes: 10 additions & 0 deletions docs/guides/README.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,16 @@
title: How-To Guides
description: here you will find really useful guides
hide_table_of_contents: true
sidebar_custom_props:
migration:
href: https://developers.stellar.org/docs/smart-contracts/guides
label: How-To Guides
---

:::danger These are not the droids you're looking for

This page has been migrated to the Stellar Developers documentation. Please [click here](https://developers.stellar.org/docs/smart-contracts/guides) for the most up-to-date information

:::

The page lists all guides we have available for Soroban. Simply put, a "guide" is a short, bite-sized example that details how to accomplish a specific task. These guides are focused on a single topic, and are limited in scope.
10 changes: 10 additions & 0 deletions docs/reference/freighter.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,18 @@
sidebar_position: 70
title: Freighter Wallet
description: Freighter is a browser extension that can sign Soroban transactions.
sidebar_custom_props:
migration:
href: https://developers.stellar.org/docs/smart-contracts/guides/freighter
label: Freighter Wallet
---

:::danger These are not the droids you're looking for

This page has been migrated to the Stellar Developers documentation. Please [click here](https://developers.stellar.org/docs/smart-contracts/guides/freighter) for the most up-to-date information

:::

[Freighter](https://www.freighter.app/) is a browser extension wallet provided by the Stellar Development Foundation. It provides users a way to interact with Soroban tokens directly from the web browser.

## Setup
Expand Down
4 changes: 2 additions & 2 deletions docs/soroban-internals/fees-and-metering.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Fees and Metering
description: Smart contract fees and metering on Soroban.
sidebar_custom_props:
migration:
href: https://developers.stellar.org/docs/learn/smart-contract-internals/fees-and-metering
href: https://developers.stellar.org/docs/learn/fundamentals/fees-resource-limits-metering
label: Fees and Metering
---

Expand All @@ -29,7 +29,7 @@ import soroban_fees from "../../static/img/soroban_fees.png";

:::danger These are not the droids you're looking for

This page has been migrated to the Stellar Developers documentation. Please [click here](https://developers.stellar.org/docs/learn/smart-contract-internals/fees-and-metering) for the most up-to-date information
This page has been migrated to the Stellar Developers documentation. Please [click here](https://developers.stellar.org/docs/learn/fundamentals/fees-resource-limits-metering) for the most up-to-date information

:::

Expand Down
10 changes: 10 additions & 0 deletions docs/tokens/stellar-asset-contract.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,18 @@
sidebar_position: 20
title: Stellar Asset Contract
description: Use Stellar assets on Soroban.
sidebar_custom_props:
migration:
href: https://developers.stellar.org/docs/smart-contracts/tokens/stellar-asset-contract
label: Stellar Asset Contract
---

:::danger These are not the droids you're looking for

This page has been migrated to the Stellar Developers documentation. Please [click here](https://developers.stellar.org/docs/smart-contracts/tokens/stellar-asset-contract) for the most up-to-date information

:::

<head>
<title>Use Stellar assets on Soroban.</title>
<meta charSet="utf-8" />
Expand Down
10 changes: 10 additions & 0 deletions docs/tokens/token-interface.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,18 @@
sidebar_position: 10
title: Token Interface
description: The common interface implemented by tokens that are compatible with Soroban's built-in tokens.
sidebar_custom_props:
migration:
href: https://developers.stellar.org/docs/smart-contracts/tokens/token-interface
label: Stellar Asset Contract
---

:::danger These are not the droids you're looking for

This page has been migrated to the Stellar Developers documentation. Please [click here](https://developers.stellar.org/docs/smart-contracts/tokens/token-interface) for the most up-to-date information

:::

Token contracts, including the Stellar Asset Contract and example token
implementations expose the following common interface.

Expand Down
12 changes: 9 additions & 3 deletions docs/tutorials/README.mdx
Original file line number Diff line number Diff line change
@@ -1,12 +1,18 @@
---
title: Tutorials
hide_table_of_contents: true
sidebar_custom_props:
migration:
href: https://developers.stellar.org/docs/smart-contracts/example-contracts
label: Tutorials
---

import DocCardList from "@theme/DocCardList";
:::danger These are not the droids you're looking for

The Soroban team has put together a large collection of [example contracts] to demonstrate use of the Soroban smart contracts platform. For many of these example contracts, we've written an accompanying "tutorial" that will walk you through the example contracts and describe a bit more about their design. You can think of these "tutorials" as example contracts that end with a deployable smart contract. You can use the provided filters to find a relevant tutorial for your experience level.
This page has been migrated to the Stellar Developers documentation. Please [click here](https://developers.stellar.org/docs/smart-contracts/example-contracts) for the most up-to-date information

:::

<DocCardList />
The Soroban team has put together a large collection of [example contracts] to demonstrate use of the Soroban smart contracts platform. For many of these example contracts, we've written an accompanying "tutorial" that will walk you through the example contracts and describe a bit more about their design. You can think of these "tutorials" as example contracts that end with a deployable smart contract. You can use the provided filters to find a relevant tutorial for your experience level.

[example contracts]: https://github.com/stellar/soroban-examples
4 changes: 0 additions & 4 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -77,10 +77,6 @@ const config = {
themeConfig:
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
({
announcementBar: {
id: 'announcementBar-migration',
content: "🎉️ <strong>We're moving!!</strong> 🎉️ We're merging the Soroban documentation into the <a target='_blank' href='https://developers.stellar.org'>Stellar Developers</a> documentation. Please check <a target='_blank' href='https://github.com/stellar/soroban-docs/issues/740'>this GH issue</a> for progress and updates.",
},
image: 'img/meta.png',
docs: {
sidebar: {
Expand Down
Loading
Loading