create web access to api docs about holochain-rust HOT 9 CLOSED

ooooh yes!

check this out https://docs.rs/crate/holochain/0.0.38-alpha13

that's awesome :D

from holochain-rust.

You can go no wrong with crates.io, if that is everyone's first choice for obtaining packages, I would say why not. We should definitely pursue it

from holochain-rust.

@zippy IIRC, any lib that is pushed to crates.io automatically gets docs built and available at https://docs.rs/

in that case, #18 could kill two birds with one stone :)

from holochain-rust.

alternatively there is a section in this tutorial explaining gh pages support - https://medium.com/@Razican/continuous-integration-and-code-coverage-report-for-a-rust-project-5dfd4d68fbe5

from holochain-rust.

Unless we choose to change this around, the github pages for holochain-rust repo is now occupied by the MDBOOK build... so we may have to create a different repo and do the build scripts to that repo to use github pages to host the API docs

from holochain-rust.

As discussed in other places, the alternative to this issue is to start shipping holochain-rust into crates.io, which would generate and host the API docs out-of-the-box. Seems like a big win.

How soon (if approved) can we do this? Starting to see how those docs look like, and start to polish them seems very important and generative

from holochain-rust.

@Connoropolous i am for pushing to crates.io ASAP. handle expectations of maturity through versioning/comms, not avoiding publishing. Everything is public on github now.

but...

@zippy @sphinxc0re @AshantiMutinta @lucksus @ddd-mtl need to input into this decision.

if it's not controversial, let's 🚢

if someone wants to wait, then we'll need to plan that wait... ADR? trello?

from holochain-rust.

Great to hear @thedavidmeister, I am curious to hear others thoughts

from holochain-rust.

Can this be closed?

https://crates.io/search?q=holochain

https://developer.holochain.org/docs/api/

from holochain-rust.