search

0xPolygonMiden / miden-client

Client library that facilitates interaction with the Miden rollup
MIT License
27 stars 23 forks source link

Revisit client docs sections organization #282

Open mFragaBA opened 2 months ago

mFragaBA commented 2 months ago

I added the docs.rs badge and removed the Library API link (the link to the documentation is under "Online Documentation"). Do you prefer "Library API" over that one?

I'd prefer to have it as it was (without the docs badge) as I would expect the badge to point to the docs to the entire client, not one aspect of it. I maybe for now we can skip Library API link since it is not working anyway - but I would like to revisit the structure of the client docs again in the future (I think some sections may be misplaced). Let's create an issue for this.

_Originally posted by @bobbinth in https://github.com/0xPolygonMiden/miden-client/pull/262#discussion_r1576513991_

bobbinth commented 2 months ago

I think the main thing here is to figure out how reconcile docs site and API docs in docs.rs (once these are working). I don't have the exact solution yet, but I think we should try to do the following:

  1. API docs on docs.rs should be self-sufficient.
  2. Docs site should focus mostly on CLI, tutorials etc. and link to the docs.rs for the API documentation.
Dominik1999 commented 1 month ago

I agree with the above.

I think the docs site should explain to a builder/user how Miden can be used. It should have an explanation about the CLI, tutorials, and some information about the architecture, as long as it is helpful to know when Miden is used.