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.

Sign up for GitHub

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

Documentation Improvements: Grammar, Structure, and Readability Fixes #1057

Merged
merged 4 commits into from
Nov 4, 2024
Merged

Documentation Improvements: Grammar, Structure, and Readability Fixes #1057

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2f00d33
Edited the documentation to remove errors
zoomyzo Nov 1, 2024
69ee5d3
fix lint issues
krofax Nov 4, 2024
5c77d0c
fix merge conflict
krofax Nov 4, 2024
479804c
updated word
krofax Nov 4, 2024
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
2 changes: 1 addition & 1 deletion pages/builders/chain-operators/self-hosted.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ There are two main steps to get started building your own self-hosted OP Chain:
blockchain to manage aspects of the Rollup. Each OP Stack chain has its own
set of [L1 smart contracts](/stack/smart-contracts#layer-1-contracts),
[L2 predeploy contracts](/stack/smart-contracts#layer-2-contracts-predeploys),
and [L2 preinstall contracts](/builders/chain-operators/features/preinstalls).
and [L2 preinstall contracts](/builders/chain-operators/features/preinstalls)
that are deployed when the chain is created.
* **Preinstalls**: OP Chains come with [preinstalled core contracts](/builders/chain-operators/features/preinstalls), making them usable as soon as a chain is initialized on the OP Stack.

Expand Down
4 changes: 2 additions & 2 deletions pages/builders/chain-operators/tools/op-conductor.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ This setup guide has the following assumptions:

```yaml
OP_NODE_CONDUCTOR_ENABLED: "true" # this is what commits unsafe blocks to the raft logs
OP_NODE_RPC_ADMIN_STATE: "" # this flag cant be used with conductor
OP_NODE_RPC_ADMIN_STATE: "" # this flag can't be used with conductor
```

{<h3>Confirm sequencer switch was successful</h3>}
Expand Down Expand Up @@ -192,7 +192,7 @@ This setup guide has the following assumptions:

Confirm all conductors successfully resumed with [conductor_paused](#conductor_paused)

{<h3>Tranfer leadership</h3>}
{<h3>Transfer leadership</h3>}

Trigger leadership transfer to `sequencer-0` using [conductor_transferLeaderToServer](#conductor_transferleadertoserver)

Expand Down
2 changes: 1 addition & 1 deletion pages/builders/chain-operators/tools/op-deployer.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ l2ContractsLocator = "tag://op-contracts/v1.7.0-beta.1+l2-contracts" # L2 smart
[[chains]]
# Your chain's ID, encoded as a 32-byte hex string
id = "0x0000000000000000000000000000000000000000000000000000000000003039"
# Update the fee receipiant contract
# Update the fee recipient contract
baseFeeVaultRecipient = "0x0000000000000000000000000000000000000000"
l1FeeVaultRecipient = "0x0000000000000000000000000000000000000000"
sequencerFeeVaultRecipient = "0x0000000000000000000000000000000000000000"
Expand Down
2 changes: 1 addition & 1 deletion pages/builders/chain-operators/tutorials/adding-precompiles.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ It means that for every precompile you need two functions:
* `RequiredGas` which returns the gas cost for the call. This function takes an array of bytes as input, and returns a single value, the gas cost.
* `Run` which runs the actual precompile. This function also takes an array of bytes, but it returns two values: the call's output (a byte array) and an error.

For every fork that changes the precompiles you have a [`map`](https://www.w3schools.com/go/go_maps.php)from addresses to the `PrecompiledContract` definitions:
For every fork that changes the precompiles you have a [`map`](https://www.w3schools.com/go/go_maps.php) from addresses to the `PrecompiledContract` definitions:

```go
// PrecompiledContractsBerlin contains the default set of pre-compiled Ethereum
Expand Down
4 changes: 2 additions & 2 deletions pages/builders/node-operators/management/metrics.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,10 +33,10 @@
| op\_node\_default\_rpc\_client\_requests\_total | Total RPC requests initiated by the opnode's RPC client | method | counter |
| op\_node\_default\_rpc\_client\_request\_duration\_seconds | Histogram of RPC client request durations | method | histogram |
| op\_node\_default\_rpc\_client\_responses\_total | Total RPC request responses received by the opnode's RPC client | method,error | counter |
| op\_node\_default\_l1\_source\_cache\_size | L1 Source cache cache size | type | gauge |
| op\_node\_default\_l1\_source\_cache\_size | L1 Source cache size | type | gauge |

Check warning on line 36 in pages/builders/node-operators/management/metrics.mdx

View workflow job for this annotation

GitHub Actions / lint 

Misaligned table fence

Check warning on line 36 in pages/builders/node-operators/management/metrics.mdx

View workflow job for this annotation

GitHub Actions / lint 

Misaligned table fence

Check warning on line 36 in pages/builders/node-operators/management/metrics.mdx

View workflow job for this annotation

GitHub Actions / lint 

Misaligned table fence
| op\_node\_default\_l1\_source\_cache\_get | L1 Source cache lookups, hitting or not | type,hit | counter |
| op\_node\_default\_l1\_source\_cache\_add | L1 Source cache additions, evicting previous values or not | type,evicted | counter |
| op\_node\_default\_l2\_source\_cache\_size | L2 Source cache cache size | type | gauge |
| op\_node\_default\_l2\_source\_cache\_size | L2 Source cache size | type | gauge |

Check warning on line 39 in pages/builders/node-operators/management/metrics.mdx

View workflow job for this annotation

GitHub Actions / lint 

Misaligned table fence

Check warning on line 39 in pages/builders/node-operators/management/metrics.mdx

View workflow job for this annotation

GitHub Actions / lint 

Misaligned table fence

Check warning on line 39 in pages/builders/node-operators/management/metrics.mdx

View workflow job for this annotation

GitHub Actions / lint 

Misaligned table fence
| op\_node\_default\_l2\_source\_cache\_get | L2 Source cache lookups, hitting or not | type,hit | counter |
| op\_node\_default\_l2\_source\_cache\_add | L2 Source cache additions, evicting previous values or not | type,evicted | counter |
| op\_node\_default\_derivation\_idle | 1 if the derivation pipeline is idle | | gauge |
Expand Down
4 changes: 2 additions & 2 deletions pages/builders/node-operators/tutorials/mainnet.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -273,7 +273,7 @@ In this section, you'll learn how to download and verify the pre-migrated databa
{<h3>Download the Migrated Data Directory</h3>}

Click the link below to find the latest publicly available database snapshots for OP Mainnet.
Snapshots are available for multiple dates and snapshots get larger as they get closer the current date.
Snapshots are available for multiple dates and snapshots get larger as they get closer to the current date.
Snapshots are large files and may take some time to download.
[OP Mainnet Snapshots](/builders/node-operators/management/snapshots#op-mainnet)

Expand All @@ -293,7 +293,7 @@ In this section, you'll learn how to download and verify the pre-migrated databa
sha256sum mainnet-bedrock.tar.zst
```

You should see then following output:
You should see the following output:

```bash
ec4baf47e309a14ffbd586dc85376833de640c0f2a8d7355cb8a9e64c38bfcd1 mainnet-bedrock.tar.zst
Expand Down
2 changes: 1 addition & 1 deletion pages/builders/tools/monitor/regenesis-history.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,6 @@ people who needed this data already retrieved it).
### Going forward

We recognize the inconvenience this has caused some of our community and their
uses and we're sorry for the frustrations. In an effort to prevent similar
users and we're sorry for the frustrations. In an effort to prevent similar
situations from happening again in the future, we are evaluating and updating
existing processes and frameworks.
Loading