investigate 2-3 documentation tools

CdC-SI / eak-copilot

The official repository of the EAK-Copilot project as part of the Innovation Fellowship 2024.

https://cdc-si.github.io/eak-copilot/

GNU General Public License v3.0

4 stars 0 forks source link

investigate 2-3 documentation tools #103

Closed K-Schubert closed 2 months ago

K-Schubert commented 3 months ago

Research tools to make a nice documentation website (similar to langchain, llamaindex, etc) such as https://docsify.js.org/#/.

tabee commented 2 months ago

@Shi-Ho : Please check https://docusaurus.io/docs

Shi-Ho commented 2 months ago

Hi @tabee ! I've done some testing with MKDocs, it is deployed on https://cdc-si.github.io/eak-copilot/ with Github pages at the moment. It is generated from MD files in the /docs folder and is pretty easy to work with, I've set up the Material theme. I can also look into Docusaurus though

tabee commented 2 months ago

very good @Shi-Ho ! can you please also keep an eye on Docusaurus and then we will decide what is best for us. soon it will be clear what our "main documentation" tool will be. please also create an new issue so that you can find a solution for the in-code documentation afterwards. 🙏