Skip to content

Refactor Chain docs to add performance and troubleshooting #2264

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

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

henridevieux
Copy link
Collaborator

@henridevieux henridevieux commented Apr 25, 2025

What changed? Why?
Refactors the layout of the Chain docs for the following changes:

  1. Makes a new section for Node Operators
  2. Adds pages there for Troubleshooting and Node Performance
  3. Moves Snapshots to it's own mdx. Makes the Run a Base Node doc import the Snapshots info for consistency
  4. Fixes broken links (the links at bottom of Network Information are broken, e.g. node partners).

New Collapsed layout:
Screenshot 2025-04-25 at 1 00 49 AM

Expanded layout:
Screenshot 2025-04-25 at 1 01 19 AM

Notes to reviewers
Draft still

How has it been tested?
Local testing

Have you tested the following pages?

BaseWeb

  • [] base.org
  • [] base.org/names
  • [] base.org/builders
  • [] base.org/ecosystem
  • [] base.org/name/jesse
  • [] base.org/manage-names
  • [] base.org/resources

BaseDocs

  • docs.base.org
  • docs sub-pages

Copy link

vercel bot commented Apr 25, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
base-web ✅ Ready (Inspect) Visit Preview 💬 Add feedback Apr 25, 2025 5:00am
web-base-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Apr 25, 2025 5:00am

@cb-heimdall
Copy link
Collaborator

cb-heimdall commented Apr 25, 2025

🟡 Heimdall Review Status

Requirement Status More Info
Reviews 🟡 0/1
Denominator calculation
Show calculation
1 if user is bot 0
1 if user is external 0
From .codeflow.yml 1
Additional review requirements
Show calculation
Max 0
0
From CODEOWNERS 0
Global minimum 0
Max 1
1
1 if commit is unverified 0
Sum 1

title: Network Information
slug: /network-information
description: Documentation about Base Mainnet and Base Testnet. This page covers network information for the Base network, including network names, descriptions, RPC endpoints, chain IDs, currency symbols, and block explorers.
title: Connecting
Copy link
Collaborator Author

@henridevieux henridevieux Apr 25, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The section header is "Network Information" so I'm using a different name to avoid

- Network Information
    - Network Information

Open to better names

| Full | [Reth](https://github.com/base/node/tree/main/reth), [Geth](https://github.com/base/node/tree/main/geth) |
| Archive | [Reth](https://github.com/base/node/tree/main/reth) |

## Geth LevelDB Tuning
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@0x00101010 do you think this belongs in a the new Node Performance docs page? I think some teams don't use base/node repo so this will help them.

author: hndvx
---

# Troubleshooting
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@wbnns do you have common troubleshooting steps listed somewhere?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants