Skip to content

Doc/add quick start#8008

Open
Surya512002 wants to merge 11 commits intoethereum-lists:masterfrom
Surya512002:doc/add-quick-start
Open

Doc/add quick start#8008
Surya512002 wants to merge 11 commits intoethereum-lists:masterfrom
Surya512002:doc/add-quick-start

Conversation

@Surya512002
Copy link

Summary

This PR improves the developer experience for new contributors by adding essential documentation to the README.

Changes

  1. Added "Quick Start" section: A step-by-step guide on how to add a new chain file, placed before the technical specs to lower the barrier to entry.
  2. Added "Troubleshooting" section: Lists common reasons for CI failures (RPC issues, duplicate Chain IDs) to reduce repetitive support questions.
  3. Formatted Usage Links: Cleaned up the "Usages" section for better readability.

Motivation

The current README is very technical (.json specs) but lacks a workflow guide. New users often struggle with the process of adding a file or debugging CI errors. These additions make the repo more self-serve.

Checks

  • Documentation updated
  • Verified markdown rendering locally

@github-actions
Copy link

You successfully submitted a PR! Due to the amount of PRs coming in: we will only look at PRs that the CI is happy with. We can also not hold your hand getting the CI green - just look how others that where merged did it and RTFM. So as long as there is any CI check that reports an error - no human will look at this. You might be able to ask for some support after supporting the project - e.g. by sending funds to lists.eth. When you fixed things after a requested change - then you also need to (re-)request a review.

Copy link

@JSTONE1111 JSTONE1111 left a comment

Choose a reason for hiding this comment

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

Ok

Copy link
Member

@ligi ligi left a comment

Choose a reason for hiding this comment

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

resolve conflicts

@Surya512002 Surya512002 requested a review from ligi January 27, 2026 12:45
@Surya512002
Copy link
Author

Yeah...I Fixed...

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.

4 participants