Anubis icon indicating copy to clipboard operation
Anubis copied to clipboard

ADD mkdocs static site generation (WIP)

Open PIG208 opened this issue 3 years ago • 1 comments

#350

This adds mkdocs to the project. The intent is to have a place to serve documentation for anything related to Anubis, either for developers, students, or site administrators. It is a proof-of-concept, so the actual documentation hasn't been added yet.

What I have in mind right now is to first reorganize the existing markdown files we have under docs/, splitting large ones into separate markdown files. For now, we can have sections like "Introduction", "Development Guide", "Design Documentation", each of which contains several markdown files.

As of deployment, we can simply host it on github pages, and update it on every push with a workflow.

You can preview the site here.

PIG208 avatar Mar 19 '22 01:03 PIG208

Very nice stuff. Just let me know if you want extra help on this one

wabscale avatar Mar 20 '22 22:03 wabscale