Skip to content

docs: enhance README with L1 RPC providers, troubleshooting, and examples#913

Open
Dark-Brain07 wants to merge 1 commit intobase:mainfrom
Dark-Brain07:docs/improve-readme-configuration
Open

docs: enhance README with L1 RPC providers, troubleshooting, and examples#913
Dark-Brain07 wants to merge 1 commit intobase:mainfrom
Dark-Brain07:docs/improve-readme-configuration

Conversation

@Dark-Brain07
Copy link

Improved README documentation to help new node operators get started faster.

Changes:

Added L1 RPC Providers section with Alchemy, Infura, QuickNode, and self-hosted examples
Enhanced Quick Start with concrete configuration examples
Converted client list to comparison table with "Best For" recommendations
Expanded Troubleshooting section covering common issues:
Node startup failures
Slow sync speed
RPC connection errors
Improved Snapshots section with step-by-step restoration instructions
Why: Addresses frequent questions from Discord 🛠|node-operators channel and reduces setup friction for new operators.

@cb-heimdall
Copy link
Collaborator

🟡 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
2 if repo is sensitive 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 1
Sum 2

@Dark-Brain07
Copy link
Author

Thanks for the automated checks.

This PR introduces a minimal and scoped change with no impact on security-sensitive logic.
I see Heimdall is requesting a review due to repository policy and an unsigned commit.

I’m happy to re-sign the commit if required, and would appreciate a maintainer review when convenient.

Thank you for your time.

@github-actions
Copy link
Contributor

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@github-actions github-actions bot added the Stale label Feb 14, 2026
@Dark-Brain07
Copy link
Author

Hey team 👋, just bumping this PR — it's still relevant and ready for review.

This is a documentation-only change that adds helpful guidance for new node operators based on common questions from the Discord 🛠|node-operators channel. No code or security-sensitive logic is affected.

Happy to make any adjustments based on feedback. Thanks for your time!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants