Create README.md for api docs root folder #60
Conversation
Creating a simple Readme to give context to users on the content and purpose of the API docs.
api/docs/README.md
Outdated
| - Churner: a hosted service responsible for maintaining the active set of Operators in the EigenDA network based on their delegated TVL. | ||
| - Disperser: the hosted service and primary point of interaction for Rollup users. | ||
| - Node: individual EigenDA nodes ran on the network by EigenLayer Operators. | ||
| - Retriever: a hosted service that retrieves blobs from EigenDA nodes. |
There was a problem hiding this comment.
The Retriever isn't hosted, it's up to users to operationalize.
There was a problem hiding this comment.
Can you share more context on what we mean by "users operationalize"?
E.g. should we say "a service that users can run on their own infrastructure, which exposes a gRPC endpoint for retrieval of blobs from EigenDA nodes"?
There was a problem hiding this comment.
@jianoaix comment addressed - retriever description updated
|
Thanks @jianoaix - should I contact anyone to ask for this pr to be merged? |
can you address the comment? |
Yes - apologies, will fix that now. Sorry - Github n00b mistake ;) |
Creating a simple README to give context to users on the content and purpose of the API docs.
Why are these changes needed?
The reader needs some context on the purpose and layout of the API docs.
Checks
Not applicable for this single README file