PhilipQuirke / quanta_maths

Tool used to verify accuracy of transformer model
Apache License 2.0
1 stars 1 forks source link

Refactor: Support better github repo documentation #25

Open amir-in-a-cynch opened 7 months ago

amir-in-a-cynch commented 7 months ago

We should create a github page with the documentation for the github repo using mkdocs and adding a yaml

This actually isn't that hard - you can see a good example here on Joseph Bloom's github repo.

https://github.com/jbloomAus/SAELens/blob/main/mkdocs.yml

A general overview is here: https://docs.readthedocs.io/en/stable/config-file/v2.html