0xPolygonMiden / miden-client

Client library that facilitates interaction with the Miden rollup
MIT License
29 stars 25 forks source link

Avoid duplicate documentation where possible #260

Closed igamigo closed 2 months ago

igamigo commented 3 months ago

What should be done?

RIght now, there are currently 3 places (AFAIK) where documentation needs to be updated whenever features are added or modified:

Furthermore, some of the information related to using the client depends on other projects (such as the node). I think we could reduce the README to more concrete information about what the client can do and reference other docs for usage examples, command explanations, etc.

How should it be done?

Deduplicate information on this repo and reference external docs when needed..

When is this task done?

Whenever the repo holds as little duplicate information as possible.

Additional context

No response

bobbinth commented 3 months ago

think we could reduce the README to more concrete information about what the client can do and reference other docs for usage examples, command explanations, etc.

I agree. When we didn't have more comprehensive docs, the README had to be pretty heavy - but now I think we can reduce the content here quite a bit.

We should also figure out how to keep the tutorial here rather than in miden-base.

mFragaBA commented 2 months ago

closing as #262 got merged