[DOC] Improve light-client documentation
Nobody has claimed this yet.
- Dominant language
- MDX
- Stars
- 186
- Forks
- 493
- Avg merge
- 29d 5h
- Merged PRs (30d)
- 1
Description
Is your feature request related to a problem? Please describe.
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
Describe the solution you'd like
We have a gap in our docs. Light Clients are not well-documented. There is no intro, motivation somebody should use it, or clear instructions on how that can be done.
https://nomicon.io/ChainSpec/LightClient is a deep technical doc. Too low-level for somebody who wants to use it.
https://github.com/near/near-light-client does not give clear instructions on how to start using it.
For reference, Ethereum doc starts from the very beginning: https://ethereum.org/en/developers/docs/nodes-and-clients/light-clients/
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the existing Light Client page at nomicon.io/ChainSpec/LightClient and the near-light-client repository, then compare their coverage with the linked Ethereum light-client documentation. Done means providing an introductory explanation, motivation, and clear instructions for getting started with Light Clients.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100