Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Upload Documentation to Github Pages using Github Actions #72

Open
lawliet89 opened this issue Nov 13, 2019 · 6 comments
Open

Upload Documentation to Github Pages using Github Actions #72

lawliet89 opened this issue Nov 13, 2019 · 6 comments

Comments

@lawliet89
Copy link
Owner Author

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.

@somehowchris
Copy link
Contributor

@lawliet89 any way I can help out on this or anything else?

@lawliet89
Copy link
Owner Author

Hey, please feel free to work on a PR if you think that's helpful. Sorry for the lack of TLC on this repo.

@somehowchris
Copy link
Contributor

What‘s the benefit of having the docs on GitHub pages instead of docs.rs?

@lawliet89
Copy link
Owner Author

The GH pages docs reflect the current state of the main/master branch. docs.rs represent the released crate versions.

@somehowchris
Copy link
Contributor

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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants