Skip to content

[DOC] Improve light-client documentation #2017

Open
@volovyks

Description

@volovyks

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/

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    Status

    No status

    Status

    Backlog 📖

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions