Continuously deployed prose documentation

[rachitnigam]

In a recent dev meeting, I brought up the possibility of setting up an automatically deploying document website. I thinks this could be a good resource to point people to and consolidate things like the build instructions and the scheduling example.

The proposal is based on the Calyx docs website which has the following setup:

• mdbook which uses markdown files with a simple folder structure and a TOC file to structure the website.
• A Github action to deploy the website on every commit to the main branch.
• The source of the documentation should live in the main repository. This makes it easier to point people to the docs when the code changes and ask for corresponding docs changes.

I've personally found the development process of docs much better. Keeping this in the same repo and automating the deployment process makes docs changes frictionless and encourages people to change them often.

[gilbo]

I'm in favor of this. The infrastructure involved also seems very minimal and easy to maintain, which is a huge plus.