Upload Documentation to Github Pages using Github Actions
lawliet89 opened this issue · comments
Yong Wen Chua commented
Yong Wen Chua commented
Travis has been disabled because of their new "plans" even for Open source projects. Docs on the Github pages will not be updated in the mean time.
Christof Weickhardt commented
@lawliet89 any way I can help out on this or anything else?
Yong Wen Chua commented
Hey, please feel free to work on a PR if you think that's helpful. Sorry for the lack of TLC on this repo.
Christof Weickhardt commented
What‘s the benefit of having the docs on GitHub pages instead of docs.rs?
Yong Wen Chua commented
The GH pages docs reflect the current state of the main/master branch. docs.rs
represent the released crate versions.
Christof Weickhardt commented
So no benefit!
Arguments:
- you shouldn't keep too much on master/main branch, release in small but useful bits
- devs see it in code
- if devs, working on this crate, need the docs generated by cargo they can generate it locally and view them
- you can use alpha and beta flags to release pre-releases to crates.io - generating the docs for docs.rs
Any reasons why I should do it?