Improve Readme

Open Beginner friendly
#9 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
62/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Domain
documentation

Research direction

Start by reading the repository README and its description of the local Celestia devnet. Expand it to explain the architecture, testnet purpose and capabilities, intended users, non-goals, and relevant alternatives. Done means each of the four checklist topics is clearly addressed in the README.

Written by the indexing model from the issue text.

Description

Write a more descriptive Readme that says:

  • What the architecture is that we are spinning up
  • What the purpose of this testnet is / What you can test with it
  • Who are the users for this testnet
  • What is not the purpose of this testnet, and what kind of alternatives are there
Dominant language
Shell
Stars
25
Forks
25
PR merge metrics
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from evstack/local-celestia-devnet

All issues in evstack/local-celestia-devnet

Similar issues

More Shell/Bash issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.