Summary

Create a Github Pages site with information on the project and guides for using or embedding RustPython.

Detailed Explanation

We currently host our WASM demo on Github Pages, but that's just on /demo, we don't use the root of the site for anything currently. I suggest that we could put a sort of landing page for RustPython at rustpython.github.io/, with information about the project and links to the project repository, the demo, and the guide. That guide would be for using the RustPython API and could be on /docs, maybe built with mdbook, showing solutions for e.g. accepting both ints and floats for a native python function 😉.

Drawbacks, Rationale, and Alternatives

My rationale is @cedric-h's PR (#1707) and discussions on gitter; it seems that there are a fair amount of people who want to embed RustPython into their Rust project, but are struggling to find good documentation for how to do so.

An alternative would be to just have markdown files in our tree that contain the documentation, but those aren't as pleasant to use and aren't necessarily as discoverable.

Unresolved Questions

Should the source be all in this repository or in multiple others? (e.g. RustPython/rustpython.github.io, RustPython/docs; it might be easier to deploy with multiple repositories, given this one's questionable CI situation.)

Related: #1677