Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Change Summary
As discussed on #48, we see valuable to publish the documentation to somewhere consumable, for future contributors to see the documentation without actually having the barrier of running
cargo doc --workspace
on their machines.I tried different things and ended up choosing netlify. Netlify has a very powerful build system and it's running on Ubuntu, but it did not allow for apt-get installs. Since we need pango and gdk to run
cargo doc
on the crate, moved to Github actions.As part of the same PR, I fixed all the warnings on cargo doc, making sure that the documentation is correctly published. The trick to deploy cargo doc is to deploy
target/doc
and then pair that with a redirect of the main page (configured rune-rs.netlify.app on my own account) to/rune
which (as the main crate) has the info about the subcrates as well.IMPORTANT: For this to work, you need to do the following steps. I would do the steps myself, but I imagined you would like to have control of the app itself, as the author of the project:
The site will be published on any push to
master
, no need to publish on PRs!Risks associated with this change
I don't really see a risk per se, other than needing to configure Netlify with the secrets of the Github repo.
Testing
Published the app on all my commits on the
docs
branch on my fork. Additionally, if you see the commit that is linked on this PR, the CI on that commit has the deployed app (running the CI I'm proposing as part of this PR).