search

mattwparas / steel

An embedded scheme interpreter in Rust
Apache License 2.0
1.07k stars 50 forks source link

Host documentation GitHub pages #120

Closed matoous closed 8 months ago

matoous commented 9 months ago

Hi!

It should be possible to host the mdbook with generated docs using GitHub Pages. The full process is described here: https://github.com/rust-lang/mdBook/wiki/Automated-Deployment%3A-GitHub-Actions#GitHub-Pages-Deploy. This could serve well for now before more elaborate approach is needed and would make it easier to explore Steel.

mattwparas commented 9 months ago

Great idea - I have a gh-pages hosted for tracking benchmark regressions from this repo. Do you know if its possible to host that and the mdbook out of the same repo at the same time?

mattwparas commented 8 months ago

So I went ahead and got this set up. The docs are a bit bare bones but I will be adding to them over the next few weeks:

They can be found at https://mattwparas.github.io/steel/book/