New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Set up docs build #38

Open

3 tasks

meshy opened this issue May 13, 2024 · 0 comments

Labels

Docs

Contributor

meshy commented May 13, 2024

We shouldn't rely on the README as the only source of documentation.

use mkdocs-material to build docs.
verify that the docs build using CI.
allow previewing built docs before merging. A good first pass at this might be to make the CI site build available as an artefact.

I'm not sure where to host it.

We may want to consider using https://github.com/jimporter/mike to make old versions of the docs available.

The contents of the documentation shouldn't be a blocker for getting this set up --- we can fill it in later.

meshy added the Docs label

meshy changed the title ~~Set up docs~~ Set up docs build

meshy mentioned this issue

Write documentation #39

Open

2 tasks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment