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

Remove public preview banners #1803

Merged
merged 3 commits into from
Nov 7, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 0 additions & 4 deletions arbitrum-docs/bold/concepts/bold-technical-deep-dive.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,6 @@ sme: leeederek
sidebar_position: 1
---

import PublicPreviewBannerPartial from '../../how-arbitrum-works/bold/partials/_bold-public-preview-banner-partial.md';

<PublicPreviewBannerPartial />

## Overview

Arbitrum's current dispute protocol involves defending against challengers individually in a 1-vs-1 tournament setting. In contrast, BoLD enables an all-vs-all battle royale between Good and Evil, with a single winner always determined.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,6 @@ content_type: concept

<!-- todo: remove this doc, redirect to existing ref doc -->

import PublicPreviewBannerPartial from '../../partials/_public-preview-banner-partial.mdx';

<PublicPreviewBannerPartial />

The Arbitrum Nitro software includes a special `NodeInterface` contract available at address `0xc8` that is only accessible via RPCs (it's not actually deployed on-chain, and thus can't be called by smart contracts). The way it works is that the node uses Geth's [`InterceptRPCMessage`](https://github.com/OffchainLabs/go-ethereum/blob/@goEthereumCommit@/internal/ethapi/api.go#L1034) hook to detect messages sent to the address `0xc8`, and swaps out the message it's handling before deriving a transaction from it.

The [reference page](/build-decentralized-apps/nodeinterface/02-reference.mdx) contains information about all methods available in the NodeInterface.
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,6 @@ user_story: As a developer, I want to understand how to bridge tokens between Et
content_type: overview
---

import PublicPreviewBannerPartial from '../../../partials/_public-preview-banner-partial.mdx';

<PublicPreviewBannerPartial />

Token bridging is a fundamental aspect of any Layer 2 (L2) protocol. It allows projects to quickly integrate with the Arbitrum ecosystem by leveraging their existing Layer 1 (L1) tokens.

This section offers a series of how-tos showcasing the different methods available for making your token bridgeable.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,6 @@ user_story: As a developer, I want to understand how to bridge tokens between Et
content_type: how-to
---

import PublicPreviewBannerPartial from '../../../partials/_public-preview-banner-partial.mdx';

<PublicPreviewBannerPartial />

In this how-to you’ll learn how to bridge your own token between Ethereum (Layer 1 or L1) and Arbitrum (Layer 2 or L2), using [Arbitrum’s standard ERC20 gateway](/build-decentralized-apps/token-bridging/03-token-bridge-erc20.md#default-standard-bridging). For alternative ways of bridging tokens, don’t forget to check out this [overview](/build-decentralized-apps/token-bridging/bridge-tokens-programmatically/01-get-started.mdx).

Familiarity with [Arbitrum’s token bridge system](/build-decentralized-apps/token-bridging/01-overview.md), smart contracts, and blockchain development is expected. If you’re new to blockchain development, consider reviewing our [Quickstart: Build a dApp with Arbitrum (Solidity, Hardhat)](/build-decentralized-apps/01-quickstart-solidity-hardhat.md) before proceeding. We will use [Arbitrum’s SDK](https://github.com/OffchainLabs/arbitrum-sdk) throughout this how-to, although no prior knowledge is required.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,6 @@ user_story: As a developer, I want to understand how to bridge tokens between Et
content_type: how-to
---

import PublicPreviewBannerPartial from '../../../partials/_public-preview-banner-partial.mdx';

<PublicPreviewBannerPartial />

In this how-to you’ll learn how to bridge your own token between Ethereum (Layer 1 or L1) and Arbitrum (Layer 2 or L2), using [Arbitrum’s generic-custom gateway](/build-decentralized-apps/token-bridging/03-token-bridge-erc20.md#the-arbitrum-generic-custom-gateway). For alternative ways of bridging tokens, don’t forget to check out this [overview](/build-decentralized-apps/token-bridging/bridge-tokens-programmatically/01-get-started.mdx).

Familiarity with [Arbitrum’s token bridge system](/build-decentralized-apps/token-bridging/01-overview.md), smart contracts, and blockchain development is expected. If you’re new to blockchain development, consider reviewing our [Quickstart: Build a dApp with Arbitrum (Solidity, Hardhat)](/build-decentralized-apps/01-quickstart-solidity-hardhat.md) before proceeding. We will use [Arbitrum’s SDK](https://github.com/OffchainLabs/arbitrum-sdk) throughout this how-to, although no prior knowledge is required.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,6 @@ reader_audience: developers who want to build on Ethereum/Arbitrum and bridge to
content_type: how-to
---

import PublicPreviewBannerPartial from '../../../partials/_public-preview-banner-partial.mdx';

<PublicPreviewBannerPartial />

:::caution Do you really need a custom gateway?

Before starting to implement and deploy a custom gateway, it is strongly encouraged to analyze the current solutions that Arbitrum’s token bridge provides: the [standard gateway](/build-decentralized-apps/token-bridging/bridge-tokens-programmatically/02-how-to-bridge-tokens-standard.mdx) and the [generic-custom gateway](/build-decentralized-apps/token-bridging/bridge-tokens-programmatically/03-how-to-bridge-tokens-generic-custom.mdx). These solutions provide enough functionality to solve the majority of bridging needs from projects. And if you are in doubt about your current approach, you can always ask for assistance on our [Discord server](https://discord.gg/arbitrum).
Expand Down
4 changes: 0 additions & 4 deletions arbitrum-docs/for-devs/dev-tools-and-resources/chain-info.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,4 @@ import ArbitrumContractAddresses from '../../partials/_reference-arbitrum-contra

import StylusFaucets from '../../stylus/reference/partials/_stylus-faucets.mdx';

import PublicPreviewBannerPartial from '../../stylus/partials/_stylus-public-preview-banner-partial.md';

<PublicPreviewBannerPartial />

<StylusFaucets />
4 changes: 0 additions & 4 deletions arbitrum-docs/for-devs/third-party-docs/contribute.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,6 @@ description: "Learn how to contribute to Arbitrum's documentation"
sidebar_position: 0
---

import PublicPreviewBannerPartial from '../../partials/_public-preview-banner-partial.mdx';

<PublicPreviewBannerPartial />

**Third-party docs** are documents that help readers of Arbitrum docs use other products, services, and protocols (like the ones listed in the [Arbitrum portal](https://portal.arbitrum.io/)) with Arbitrum products.

These documents are usually authored by partner teams, but can be authored by anyone. They follow the same general process that [core docs](/for-devs/contribute#add-a-new-core-document) follow, in addition to the following guidelines:
Expand Down
4 changes: 0 additions & 4 deletions arbitrum-docs/how-arbitrum-works/bold/gentle-introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,6 @@ author: leeederek
sme: leeederek
---

import PublicPreviewBannerPartial from './partials/_bold-public-preview-banner-partial.md';

<PublicPreviewBannerPartial />

This introduction is for those who want to learn about BoLD: a new dispute protocol for Optimistic Rollups that can enable **permissionless validation for Arbitrum chains**. BoLD stands for Bounded Liquidity Delay and is currently deployed on a public testnet for anyone to join and test how challenges will work.

This next-generation dispute protocol technology will soon be available for any Arbitrum chain, and pending a governance vote, will eventually be made available on Arbitrum Sepolia, Arbitrum One, and Arbitrum Nova.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,6 @@ Offchain Labs builds products in a way that aligns loosely with the spirit of "b

To do this, some of our product offerings are documented with **public preview** disclaimers that look like this:

import PublicPreviewBannerPartial from './partials/_bold-public-preview-banner-partial.md';

<PublicPreviewBannerPartial />

This banner's purpose is to set expectations while inviting readers like you to express your needs so that we can incorporate them into the way that we iterate on product.

### What to expect when using public preview offerings
Expand Down
4 changes: 0 additions & 4 deletions arbitrum-docs/intro/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,6 @@ description: 'Arbitrum is a suite of Ethereum Layer-2 scaling solutions that you
author: dzgoldman
---

import PublicPreviewBannerPartial from '../partials/_public-preview-banner-partial.mdx';

<PublicPreviewBannerPartial />

import GentleIntroPartial from '../partials/_gentle-intro-partial.mdx';

<GentleIntroPartial />
4 changes: 0 additions & 4 deletions arbitrum-docs/launch-orbit-chain/concepts/chain-ownership.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,6 @@ An Orbit chain's initial chain owner is set by the chain's creator when the chai

The chain-ownership architecture is designed to give Orbit chain creators flexibility in deciding how upgrades to their chain occur.

import PublicPreviewBannerPartial from '../partials/_orbit-public-preview-banner-partial.md';

<PublicPreviewBannerPartial />

### Architecture

Chain ownership affordance is handled via [**Upgrade Executor**](https://github.com/OffchainLabs/upgrade-executor) contracts.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,6 @@ sidebar_position: 2

Arbitrum SDK is a TypeScript library for client-side interactions with Arbitrum. It provides common helper functionality as well as access to the underlying smart contract interfaces.

import PublicPreviewBannerPartial from '../partials/_orbit-public-preview-banner-partial.md';

<PublicPreviewBannerPartial />

### Custom gas token APIs

Custom gas token support in the Arbitrum SDK introduces a suite of APIs designed for the specific purpose of facilitating **bridging** operations. These APIs are tailored for use cases where there is a need to transfer a native token or an ERC-20 token from the parent chain to an orbit chain utilizing a `custom gas token`. The process involves an initial step of authorizing the native token on the parent chain. To streamline this, our APIs provide functionalities for token approval and offer a mechanism to verify the current status of this approval. Detailed below is a guide to how each of these APIs can be effectively utilized for distinct purposes:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,6 @@ Offchain Labs builds products in a way that aligns loosely with the spirit of "b

To do this, some of our product offerings are documented with **public preview** disclaimers that look like this:

import PublicPreviewBannerPartial from '../partials/_orbit-public-preview-banner-partial.md';

<PublicPreviewBannerPartial />

This banner's purpose is to set expectations while inviting readers like you to express your needs so that we can incorporate them into the way that we iterate on product.

### What to expect when using public preview offerings
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,6 @@ sme: jose-franco
sidebar_position: 2
---

import PublicPreviewBannerPartial from '../partials/_orbit-public-preview-banner-partial.md';

<PublicPreviewBannerPartial />

This how-to will walk you through the process of adding your Orbit chain to the [Arbitrum bridge](https://bridge.arbitrum.io/). There's one section for mainnet Orbit chains, and another for local testnet Orbit chains. You can access either section using the links on the right column.

## Request adding a mainnet Orbit chain to the Arbitrum bridge
Expand Down
4 changes: 0 additions & 4 deletions arbitrum-docs/launch-orbit-chain/how-tos/arbos-upgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,6 @@ This how-to provides step-by-step instructions for Orbit chain operators who wan

The specific upgrade requirements for each ArbOS release are located under each reference page for that specific [ArbOS release](/run-arbitrum-node/arbos-releases/01-overview.md#list-of-available-arbos-releases).

import PublicPreviewBannerPartial from '../../node-running/partials/_upgrade-cadence-recommendations-partial.mdx';

<PublicPreviewBannerPartial />

#### Step 1: Update Nitro on nodes and validators

Refer to the [requirements for the targeted ArbOS release](/run-arbitrum-node/arbos-releases/01-overview.md) to identify the specific [Nitro release](https://github.com/OffchainLabs/nitro/releases/) that supports the ArbOS version that you're upgrading to. For example, if your upgrade targets ArbOS 20, you'd use Nitro `v2.3.1` (Docker image: `offchainlabs/nitro-node:v2.3.1-26fad6f`) or higher. This is the version of the Nitro stack that needs to be running on each of your Orbit chain's nodes. A list of [all Nitro releases can be found on Github](https://github.com/OffchainLabs/nitro/releases).
Expand Down
3 changes: 0 additions & 3 deletions arbitrum-docs/launch-orbit-chain/how-tos/customize-arbos.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,8 @@ sidebar_position: 7
content_type: how-to
---

import PublicPreviewBannerPartial from '../partials/_orbit-public-preview-banner-partial.md';
import CustomizeCautionBannerPartial from '../partials/_orbit-customize-caution-banner-partial.md';

<PublicPreviewBannerPartial />

<CustomizeCautionBannerPartial />

## Cases where you may want to consider customizing your own ArbOS upgrade
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,6 @@ author: symbolpunk
sidebar_position: 1
---

import PublicPreviewBannerPartial from '../partials/_orbit-public-preview-banner-partial.md';

<PublicPreviewBannerPartial />

When you visit the [Orbit chain deployment portal](https://orbit.arbitrum.io/) to launch your Orbit chain, you'll be prompted to complete a form that looks like this:

import { PlaceholderForm } from '/src/components/PlaceholderForm/PlaceholderForm';
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,8 @@ sidebar_position: 5
content_type: how-to
---

import PublicPreviewBannerPartial from '../partials/_orbit-public-preview-banner-partial.md';
import CustomizeCautionBannerPartial from '../partials/_orbit-customize-caution-banner-partial.md';

<PublicPreviewBannerPartial />

<CustomizeCautionBannerPartial />

:::caution
Expand Down
3 changes: 0 additions & 3 deletions arbitrum-docs/launch-orbit-chain/how-tos/customize-stf.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,8 @@ sidebar_position: 4
content_type: how-to
---

import PublicPreviewBannerPartial from '../partials/_orbit-public-preview-banner-partial.md';
import CustomizeCautionBannerPartial from '../partials/_orbit-customize-caution-banner-partial.md';

<PublicPreviewBannerPartial />

<CustomizeCautionBannerPartial />

## Introduction
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,6 @@ sidebar_position: 6
content_type: how-to
---

import PublicPreviewBannerPartial from '../partials/_orbit-public-preview-banner-partial.md';

<PublicPreviewBannerPartial />

As part of the activity of an Orbit chain, different fees are collected with every transaction. These fees are collected as a single amount (the transaction fees) but are internally split into different components depending on their purpose. Each component can also be transferred to a different fee collector address that can be configured on your chain.

This guide describes the different fees that are collected, and explains how to specify the fee collector address on your chain for each fee type.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,6 @@ sidebar_position: 3
content_type: how-to
---

import PublicPreviewBannerPartial from '../partials/_orbit-public-preview-banner-partial.md';

<PublicPreviewBannerPartial />

When deploying your AnyTrust Orbit chain you have the option of using a custom gas token, different than ETH, that is natively used for gas payments on the network. When choosing this option, there are certain requirements that the token needs to comply with, as well as certain chain configuration that needs to be adjusted. This guide covers this information.

## Requirements of the custom gas token
Expand Down
4 changes: 0 additions & 4 deletions arbitrum-docs/launch-orbit-chain/orbit-gentle-introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,6 @@ This document is for developers and decision-makers who want to learn more about

If you'd prefer to learn by doing, see the [Orbit quickstart](./orbit-quickstart) for step-by-step instructions that walk you through the process of configuring and launching your own Orbit chain.

import PublicPreviewBannerPartial from './partials/_orbit-public-preview-banner-partial.md';

<PublicPreviewBannerPartial />

### In a nutshell:

- Arbitrum Orbit is the **permissionless path** for launching customizable dedicated chains using Arbitrum technology.
Expand Down
4 changes: 0 additions & 4 deletions arbitrum-docs/launch-orbit-chain/orbit-quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,6 @@ By the end of this quickstart, you'll have a **local devnet chain** that hosts E

If you're looking for a conceptual introduction to Orbit chains, see the [Gentle introduction to Orbit chains](/launch-orbit-chain/orbit-gentle-introduction.md).

import PublicPreviewBannerPartial from './partials/_orbit-public-preview-banner-partial.md';

<PublicPreviewBannerPartial />

## Prerequisites

- [Docker](https://docs.docker.com/get-docker/)
Expand Down
4 changes: 0 additions & 4 deletions arbitrum-docs/launch-orbit-chain/orbit-sdk-introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,6 @@ user_story: As a current or prospective Orbit chain owner, I need to onboard int
content_type: get-started
---

import PublicPreviewBannerPartial from './partials/_orbit-public-preview-banner-partial.md';

<PublicPreviewBannerPartial />

The Arbitrum Orbit SDK lets you programmatically create and manage your own Orbit chain(s). Its capabilities include:

- Configuration and deployment of your Orbit chain's core contracts
Expand Down
4 changes: 0 additions & 4 deletions arbitrum-docs/run-arbitrum-node/02-quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,6 @@ reader-task: Run a node with minimal effort and maximum understanding
content_type: quickstart
---

import PublicPreviewBannerPartial from '../partials/_public-preview-banner-partial.mdx';

<PublicPreviewBannerPartial />

:::info

There is no protocol level incentive to run an Arbitum full node. If you’re interested in accessing an Arbitrum chain, but you don’t want to set up your own node, see our [RPC endpoints and providers](/build-decentralized-apps/reference/01-node-providers.md) to get RPC access to fully-managed nodes hosted by a third party provider.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,6 @@ title: 'L1 Ethereum beacon chain RPC providers'
author: dlee
---

import PublicPreviewBannerPartial from '../partials/_public-preview-banner-partial.mdx';

<PublicPreviewBannerPartial />

:::info Note
This reference document provides an overview of Ethereum beacon chain RPC providers for Arbitrum validators to use for accessing blob data following Ethereum's Dencun upgrade in March 2024. The list curated here is **not comprehensive and in no way does Offchain Labs endorse or benefit from your use of any of these providers.**
:::
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,6 @@ sidebar_position: 1
content_type: overview
---

import PublicPreviewBannerPartial from '../../partials/_public-preview-banner-partial.mdx';

<PublicPreviewBannerPartial />

<p>
<a data-quicklook-from="arbitrum-anytrust-protocol">AnyTrust</a> chains rely on an external Data
Availability Committee (DAC) to store data and provide it on-demand instead of using its{' '}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,6 @@ sidebar_position: 2
content_type: how-to
---

import PublicPreviewBannerPartial from '../../partials/_public-preview-banner-partial.mdx';

<PublicPreviewBannerPartial />

<p>
<a data-quicklook-from="arbitrum-anytrust-protocol">AnyTrust</a> chains rely on an external Data
Availability Committee (DAC) to store data and provide it on-demand instead of using its{' '}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,6 @@ sidebar_position: 3
content_type: how-to
---

import PublicPreviewBannerPartial from '../../partials/_public-preview-banner-partial.mdx';

<PublicPreviewBannerPartial />

:::caution Running a regular DAS vs running a mirror DAS

The main use-case for running a mirror DAS is to complement your setup as a Data Availability Committee (DAC) member. That means that you should run your main DAS first, and then configure the mirror DAS. Refer to _[How to deploy a DAS](/run-arbitrum-node/data-availability-committees/02-deploy-das.md)_ if needed.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,6 @@ sidebar_position: 4
content_type: how-to
---

import PublicPreviewBannerPartial from '../../partials/_public-preview-banner-partial.mdx';

<PublicPreviewBannerPartial />

<p>
<a data-quicklook-from="arbitrum-anytrust-protocol">AnyTrust</a> chains rely on an external Data
Availability Committee (DAC) to store data and provide it on-demand instead of using its{' '}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,6 @@ sidebar_position: 7
content_type: how-to
---

import PublicPreviewBannerPartial from '../../partials/_public-preview-banner-partial.mdx';

<PublicPreviewBannerPartial />

Arbitrum Nitro is the software that powers all Arbitrum chains. This how-to shows how you can build a Docker image, or binaries, directly from Nitro's source code. If you want to run a node for one of the Arbitrum chains, however, it is recommended that you use the docker image available on DockerHub, as explained in [How to run a full node](/run-arbitrum-node/03-run-full-node.md).

This how-to assumes that you're running one of the following operating systems:
Expand Down
4 changes: 0 additions & 4 deletions arbitrum-docs/run-arbitrum-node/run-nitro-dev-node.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,6 @@ content_type: how-to
sidebar_position: 5
---

import PublicPreviewBannerPartial from '../partials/_public-preview-banner-partial.mdx';

<PublicPreviewBannerPartial />

## Overview

This page provides step-by-step instructions for setting up and running a local Nitro node in `--dev` mode. This mode is ideal for developers who want to quickly test contracts using a single node, as it offers a simpler and faster setup compared to more complex environments.
Expand Down
Loading
Loading