starkware-libs / cairo

Cairo is the first Turing-complete language for creating provable programs for general computation.
Apache License 2.0
1.53k stars 474 forks source link

feat: offline docs suggestion #3196

Open rkdud007 opened 1 year ago

rkdud007 commented 1 year ago

Feature Request

Describe the Feature Request

Context of Request

  1. Want to read docs in offline situation -- like on flight
  2. currently there are many documentation materials are scattered

Enabling offline docs command on cairo ( just like howrustup docs works ). And show the docs page that combine multiple docs of cairo related docs and meterials. ex. starkling, starknet-book, cairo-book

Describe Preferred Solution

For now, can do it like cargo run --bin cairo-docs. Could be added on Cairo toolchain installer like Scarb or Protostar

Describe Alternatives

Related Code

Additional Context

If the feature request is approved, would you be willing to submit a PR? (Help can be provided if you need assistance submitting a PR)

orizi commented 1 year ago

note that only the main docs are actually contained in the repo (starkling and books aren't there). and i don't think we should depend on these directly from the repo, so exporting the main docs makes sense, but do you have a more encompassing suggestion for the rest? (this just might be something fully external)

rkdud007 commented 1 year ago

like I mentioned above, i got inspired by rust off line docs, which not only contain rust book, but also containing related documentations that might be helpful. So in my opinion, not only exporting main docs, can export kind of index page that contains community's documentations would be very cool to represent starknet developer ecosystem :)