Brief summary
We should host the documentation for the project on GitHub Pages, which gets updated by a GitHub Action. This action will base off of the docs
branch for docs generation.
The action should run only on release so that we only push stable docs to the docs repo, as not to add dev features to docs that aren't stabilised yet.
The action should end up hosting the docs on https://amy.is-a.dev/JVM/ though this will require extra tooling as rust doc
does not generate GH pages compatible HTML. If such a hosting solution is not possible, we will have to investigate renaming to make the URL usable.
Progress
- [x] Enable GitHub Pages for the repository
- [x] Add action to build docs
Status
Ongoing
documentation up for grabs todo