Skip to content

Commit c687aae

Browse files
minor readability changes; style
1 parent 3f4bda2 commit c687aae

File tree

4 files changed

+51
-58
lines changed

4 files changed

+51
-58
lines changed

arbitrum-docs/node-running/node-running-content-map.mdx

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -19,79 +19,79 @@ Learn how to run an Arbitrum node.
1919
>
2020
<Card
2121
title="What node should I run?"
22-
description="Overview of node types."
22+
description="Overview of node types"
2323
href="/run-arbitrum-node/overview"
2424
target="_blank"
2525
/>
2626
<Card
2727
title="Run a full node"
28-
description="Installation and configuration."
28+
description="Installation and configuration"
2929
href="/run-arbitrum-node/run-full-node"
3030
target="_blank"
3131
/>
3232
<Card
3333
title="Run a local dev node"
34-
description="Installation and configuration."
34+
description="Installation and configuration"
3535
href="/run-arbitrum-node/run-nitro-dev-node"
3636
target="_blank"
3737
/>
3838
<Card
3939
title="Run a validator node"
40-
description="Installation and configuration."
40+
description="Installation and configuration"
4141
href="/run-arbitrum-node/more-types/run-validator-node"
4242
target="_blank"
4343
/>
4444
<Card
4545
title="Data Availability Committees"
46-
description="Setup an Orbit AnyTrust node."
46+
description="Setup an Arbitrum chain AnyTrust node"
4747
href="/run-arbitrum-node/data-availability-committees/get-started"
4848
target="_blank"
4949
/>
5050
<Card
5151
title="Run an archive node"
52-
description="Installation and configuration."
52+
description="Installation and configuration"
5353
href="/run-arbitrum-node/more-types/run-archive-node"
5454
target="_blank"
5555
/>
5656
<Card
5757
title="Run a Classic node"
58-
description="Installation and configuration."
58+
description="Installation and configuration"
5959
href="/run-arbitrum-node/more-types/run-classic-node"
6060
target="_blank"
6161
/>
6262
<Card
6363
title="Sequencer"
64-
description="Keep your node in sync with the sequencer."
64+
description="Keep your node in sync with the sequencer"
6565
href="/node-running/sequencer-content-map"
6666
target="_blank"
6767
/>
6868
<Card
6969
title="Use a node provider"
70-
description="Infrastructure node list."
70+
description="Infrastructure node list"
7171
href="/build-decentralized-apps/reference/node-providers"
7272
target="_blank"
7373
/>
7474
<Card
7575
title="Beacon Chain RPC providers"
76-
description="Beacon Chain provider list."
76+
description="Beacon Chain provider list"
7777
href="/run-arbitrum-node/l1-ethereum-beacon-chain-rpc-providers"
7878
target="_blank"
7979
/>
8080
<Card
8181
title="ArbOS software releases"
82-
description="ArbOS release list."
82+
description="ArbOS release list"
8383
href="/run-arbitrum-node/arbos-releases/overview"
8484
target="_blank"
8585
/>
8686
<Card
8787
title="Troubleshooting"
88-
description="Common issues and solutions."
88+
description="Common issues and solutions"
8989
href="/run-arbitrum-node/troubleshooting"
9090
target="_blank"
9191
/>
9292
<Card
9393
title="FAQ"
94-
description="Frequently asked questions."
94+
description="Frequently asked questions"
9595
href="/node-running/faq"
9696
target="_blank"
9797
/>

arbitrum-docs/run-arbitrum-node/01-overview.mdx

Lines changed: 15 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -12,54 +12,47 @@ import { VanillaAdmonition } from '@site/src/components/VanillaAdmonition/';
1212

1313
<VanillaAdmonition type="note">
1414

15-
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.mdx) to get RPC access to fully-managed nodes hosted by a third party provider.
15+
There is no protocol-level incentive to run an Arbitum full node. If you’re interested in accessing an Arbitrum chain but don’t want to set up a node locally, see our [RPC endpoints and providers](/build-decentralized-apps/reference/01-node-providers.mdx) to get RPC access to fully managed nodes hosted by a third-party provider.
1616

1717
</VanillaAdmonition>
1818

1919
:::caution API security disclaimer
2020

2121
When exposing API endpoints to the Internet or any untrusted/hostile network, the following risks may arise:
2222

23-
- Increased risk of crashes due to OOM:
24-
Exposing endpoints raises the risk of Out-of-Memory (OOM) crashes.
25-
- Increased risk of not keeping up with chain progression:
23+
- **Increased risk of crashes due to Out-of-Memory (OOM)**:
24+
Exposing endpoints increases the risk of OOM crashes.
25+
- **Increased risk of not keeping up with chain progression**:
2626
Resource starvation (IO or CPU) may occur, leading to an inability to keep up with chain progression.
2727

2828
We strongly advise against exposing API endpoints publicly. Users considering such exposure should exercise caution and implement the right measures to enhance resilience.
29+
2930
:::
3031

31-
In order to be able to _interact with_ or _build applications on_ any of the Arbitrum chains, you need access to the corresponding Arbitrum node. Options are:
32+
To be able to _interact with_ or _build applications on_ any of the Arbitrum chains, you need access to the corresponding Arbitrum node. Options are:
3233

3334
- You can use [ third party node providers ](/build-decentralized-apps/reference/01-node-providers.mdx) to get RPC access to fully-managed nodes
34-
- You can run your own Arbitrum node, especially if you want to always know the state of the Arbitrum chain
35+
- You can run your own Arbitrum node, especially if you want always to know the state of the Arbitrum chain
3536

3637
The rest of this series focuses on the second approach: running your own Arbitrum node.
3738

38-
When exposing API endpoints to the Internet or any untrusted/hostile network, the following risks may arise:
39-
40-
- Increased risk of crashes due to OOM:
41-
Exposing endpoints raises the risk of Out-of-Memory (OOM) crashes.
42-
- Increased risk of not keeping up with chain progression:
43-
Resource starvation (IO or CPU) may occur, leading to an inability to keep up with chain progression.
44-
45-
We strongly advise against exposing API endpoints publicly. Users considering such exposure should exercise caution and implement the right measures to enhance resilience.
4639
:::
4740

48-
In order to be able to _interact with_ or _build applications on_ any of the Arbitrum chains, you need access to the corresponding Arbitrum node. Options are:
41+
To be able to _interact with_ or _build applications on_ any of the Arbitrum chains, you need access to the corresponding Arbitrum node. Options are:
4942

50-
When it comes to interacting with the Arbitrum network, users have the option to run either a full node or an archive node. There are distinct advantages to running an Arbitrum full node. In this quickstart, we will explore the reasons why a user may prefer to run a full node instead of an archive node. By understanding the benefits and trade-offs of each type of node, users can make an informed decision based on their specific requirements and objectives.
43+
When interacting with the Arbitrum network, users have the option to run either a full node or an archive node. There are distinct advantages to running an Arbitrum full node. In this quick start, we will explore the reasons why a user may prefer to run a full node instead of an archive node. By understanding the benefits and trade-offs of each node type, users can make an informed decision based on their specific requirements and objectives.
5144

5245
### Considerations for running an Arbitrum full node
5346

54-
- Transaction validation and security: Running a full node allows users to independently validate transactions and verify the state of the Arbitrum blockchain. Users can have full confidence in the authenticity and integrity of the transactions they interact with.
55-
- Reduced trust requirements: By running a full node, users can interact with the Arbitrum network without relying on third-party services or infrastructure. This reduces the need to trust external entities and mitigates the risk of potential centralized failures or vulnerabilities.
56-
- Lower resource requirements: Compared to archive nodes, full nodes generally require fewer resources such as storage and computational power. This makes them more accessible to users with limited hardware capabilities or those operating on resource-constrained environments.
47+
- **Transaction validation and security**: Running a full node allows users to independently validate transactions and verify the state of the Arbitrum blockchain. Users can have complete confidence in the authenticity and integrity of the transactions they interact with.
48+
- **Reduced trust requirements**: By running a full node, users can interact with the Arbitrum network without relying on third-party services or infrastructure. This independence reduces the need to trust external entities and mitigates the risk of potential centralized failures or vulnerabilities.
49+
- **Lower resource requirements**: Compared to archive nodes, full nodes generally require fewer resources such as storage and computational power. These requirements make it more accessible to users with limited hardware capabilities or those operating in resource-constrained environments.
5750

5851
For detailed instructions, read [how to run an Arbitrum full node](/run-arbitrum-node/02-run-full-node.mdx).
5952

6053
### Considerations for running an Arbitrum archive node
6154

62-
While full nodes offer numerous advantages, there are situations where running an archive node may be more appropriate. Archive nodes store the complete history of the Arbitrum network, making them suitable for users who require extensive historical data access or advanced analytical purposes. However, it's important to note that archive nodes are more resource-intensive, requiring significant storage capacity and computational power.
55+
While full nodes offer numerous advantages, there are situations where running an archive node may be more appropriate. Archive nodes store the complete history of the Arbitrum network, making them suitable for users who require access to extensive historical data or advanced analytical purposes. However, it's important to note that archive nodes are more resource-intensive, requiring significant storage capacity and computational power.
6356

6457
For detailed instructions, read [how to run an Arbitrum archive node](/run-arbitrum-node/more-types/01-run-archive-node.mdx).
6558

@@ -71,8 +64,8 @@ For detailed instructions, read [how to run an Arbitrum classic node](/run-arbit
7164

7265
### Considerations for running a feed relay
7366

74-
If you are running a single node, there is no requirement to set up a feed relay. However, if you have multiple nodes, it is highly recommended to have a single feed relay per datacenter. This setup offers several advantages such as reducing ingress fees and enhancing stability within the network.
67+
If you are running a single node, there is no requirement to set up a feed relay. However, if you have multiple nodes, it is highly recommended to have a single feed relay per data center. This setup offers several advantages, including reducing ingress fees and enhancing network stability.
7568

76-
In the near future, feed endpoints will mandate compression using a custom dictionary. Therefore, if you plan to connect to a feed using anything other than a standard node, it is strongly advised to run a local feed relay. This will ensure that you have access to an uncompressed feed by default, maintaining optimal performance and compatibility.
69+
Soon, feed endpoints will mandate compression using a custom dictionary. Therefore, if you plan to connect to a feed using anything other than a standard node, it is strongly advised to run a local feed relay. This local feed relay will ensure that you have access to an uncompressed feed by default, maintaining optimal performance and compatibility.
7770

7871
For detailed instructions, read [how to run an Arbitrum feed relay](/run-arbitrum-node/sequencer/01-run-feed-relay.mdx).

arbitrum-docs/stylus/stylus-content-map.mdx

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -19,73 +19,73 @@ Let's learn how to write contracts with Stylus!
1919
>
2020
<Card
2121
title="A gentle introduction"
22-
description="Start with the basics of Stylus contracts."
22+
description="Start with the basics of Stylus contracts"
2323
href="/stylus/stylus-gentle-introduction"
2424
target="_blank"
2525
/>
2626
<Card
2727
title="Quickstart (Rust)"
28-
description="Get started quickly with Rust."
28+
description="Get started quickly with Rust"
2929
href="/stylus/stylus-quickstart"
3030
target="_blank"
3131
/>
3232
<Card
3333
title="Testnet"
34-
description="Explore the testnet environment."
34+
description="Explore the testnet environment"
3535
href="/stylus/reference/testnet-information"
3636
target="_blank"
3737
/>
3838
<Card
3939
title="Stylus by example"
40-
description="Learn Stylus through examples."
40+
description="Learn Stylus through examples"
4141
href="https://stylus-by-example.org"
4242
target="_blank"
4343
/>
4444
<Card
4545
title="Stylus Rust SDK"
46-
description="Dive into the Stylus Rust SDK."
46+
description="Dive into the Stylus Rust SDK"
4747
href="/stylus/reference/rust-sdk-guide"
4848
target="_blank"
4949
/>
5050
<Card
5151
title="Gas, ink and caching"
52-
description="Learn about gas, ink, and caching strategies."
52+
description="Learn about gas, ink, and caching strategies"
5353
href="/stylus/concepts/stylus-gas"
5454
target="_blank"
5555
/>
5656
<Card
5757
title="CLI tools (cargo-stylus)"
58-
description="Master the CLI tools for Stylus."
58+
description="Master the CLI tools for Stylus"
5959
href="/stylus/cli-tools-overview"
6060
target="_blank"
6161
/>
6262
<Card
6363
title="Run a Stylus dev node"
64-
description="Set up and run a development node."
64+
description="Set up and run a development node"
6565
href="/run-arbitrum-node/run-local-dev-node"
6666
target="_blank"
6767
/>
6868
<Card
6969
title="Other supported languages"
70-
description="Explore other languages supported by Stylus."
70+
description="Explore other languages supported by Stylus"
7171
href="/stylus/reference/stylus-sdk"
7272
target="_blank"
7373
/>
7474
<Card
7575
title="Troubleshooting"
76-
description="Find solutions to common issues."
76+
description="Find solutions to common issues"
7777
href="/stylus/troubleshooting-building-stylus"
7878
target="_blank"
7979
/>
8080
<Card
8181
title="Source code repository"
82-
description="Check out the source code."
82+
description="Check out the source code"
8383
href="https://github.com/OffchainLabs/stylus"
8484
target="_blank"
8585
/>
8686
<Card
8787
title="Public preview"
88-
description="View the public preview of Stylus."
88+
description="View the public preview of Stylus"
8989
href="/stylus/concepts/public-preview-expectations"
9090
target="_blank"
9191
/>

arbitrum-docs/welcome/get-started.mdx

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -14,17 +14,17 @@ Arbitrum suite along with onboarding guidance tailored to specific audiences.
1414

1515
The Arbitrum suite includes the protocols, chains, services, and SDKs that power the Arbitrum ecosystem:
1616

17-
| Component | Description |
18-
| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
19-
| [Arbitrum Rollup](/how-arbitrum-works/05-validation-and-proving/02-rollup-protocol.mdx) | A **protocol** for scaling Ethereum smart contracts. |
20-
| [Arbitrum AnyTrust](/how-arbitrum-works/08-anytrust-protocol.mdx) | A **protocol** for scaling Ethereum smart contracts even further, with a mild trust assumption. |
21-
| [Arbitrum Nitro](/how-arbitrum-works/01-a-gentle-introduction.mdx) | The node **software** that codifies the Rollup and AnyTrust protocols. |
22-
| [Arbitrum nodes](/run-arbitrum-node/02-run-full-node.mdx) | **Machines** that run Nitro in order to service and/or interact with an Arbitrum chain. |
23-
| [Arbitrum One](https://portal.arbitrum.io/?chains=arbitrum-one) | A public Rollup **chain**. |
24-
| [Arbitrum Nova](https://portal.arbitrum.io/?chains=arbitrum-nova) | A public AnyTrust **chain**. |
25-
| [Arbitrum bridge](https://bridge.arbitrum.io/) | Lets you move ETH and ERC-20 tokens between Ethereum, Arbitrum, and select Arbitrum (Orbit) chains. |
26-
| [Arbitrum (Orbit) chains](https://orbit.arbitrum.io/) | Lets you run your own Rollup and AnyTrust chains. |
27-
| [Arbitrum Stylus](/stylus/gentle-introduction.mdx) | Lets you write EVM-compatible smart contracts in Rust and any other language that compiles to Wasm. |
17+
| Component | Description |
18+
| --------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
19+
| [Arbitrum Rollup](/how-arbitrum-works/05-validation-and-proving/02-rollup-protocol.mdx) | A **protocol** for scaling Ethereum smart contracts. |
20+
| [Arbitrum AnyTrust](/how-arbitrum-works/08-anytrust-protocol.mdx) | A **protocol** for scaling Ethereum smart contracts even further, with a mild trust assumption. |
21+
| [Arbitrum Nitro](/how-arbitrum-works/01-a-gentle-introduction.mdx) | The node **software** that codifies the Rollup and AnyTrust protocols. |
22+
| [Arbitrum nodes](/run-arbitrum-node/02-run-full-node.mdx) | **Machines** that run Nitro in order to service and/or interact with an Arbitrum chain. |
23+
| [Arbitrum One](https://portal.arbitrum.io/?chains=arbitrum-one) | A public Rollup **chain**. |
24+
| [Arbitrum Nova](https://portal.arbitrum.io/?chains=arbitrum-nova) | A public AnyTrust **chain**. |
25+
| [Arbitrum bridge](https://bridge.arbitrum.io/) | Lets you move `ETH` and `ERC-20` tokens between Ethereum, Arbitrum, and select Arbitrum (Orbit) chains. |
26+
| [Arbitrum (Orbit) chains](https://orbit.arbitrum.io/) | Lets you run your own Rollup and AnyTrust chains. |
27+
| [Arbitrum Stylus](/stylus/gentle-introduction.mdx) | Lets you write EVM-compatible smart contracts in Rust and any other language that compiles to Wasm. |
2828

2929
## Arbitrum for users
3030

0 commit comments

Comments
 (0)