Anubis icon indicating copy to clipboard operation
Anubis copied to clipboard

ADD Documentation for Anubis CLI and Grading IDE

Open PIG208 opened this issue 3 years ago • 4 comments

PIG208 avatar Mar 11 '22 02:03 PIG208

We've needed this for a while now. The hope that I've had is that we could put some kind of a knowledge base or something on the website itself. We could just do markdown pages and stuff like how the blog is.

What were you thinking for this?

wabscale avatar Mar 11 '22 04:03 wabscale

Honestly I don't think Markdown is suitable for documentations. I think we can try gitbook or Read the Docs and just incrementally add stuff to it over time.

AlpacaMax avatar Mar 11 '22 06:03 AlpacaMax

I would say mkdocs looks pretty good. FastAPI for example uses it https://github.com/tiangolo/fastapi/tree/master/docs

PIG208 avatar Mar 11 '22 17:03 PIG208

Honestly I don't think Markdown is suitable for documentations. I think we can try gitbook or Read the Docs and just incrementally add stuff to it over time.

We can use some existing static site tools for doc so that we don't need to reinvent the wheels, but still need to write markdowns anyway.

PIG208 avatar Mar 11 '22 17:03 PIG208

Closing because we are getting it in https://github.com/AnubisLMS/CLI.

PIG208 avatar Sep 10 '22 01:09 PIG208