HowieHwong / TrustLLM

[ICML 2024] TrustLLM: Trustworthiness in Large Language Models
https://trustllmbenchmark.github.io/TrustLLM-Website/
MIT License
357 stars 30 forks source link

Add a workflow to publish the docs with github actions #5

Closed sugatoray closed 5 months ago

sugatoray commented 5 months ago

Material for MkDocs generated documentation can be created with a GitHub workflow. Adding this will ensure the documentation gets updated in-sync with the codebase.

Here's an example: https://sugatoray.github.io/TrustLLM/index.html

Go to settings of this repository, then choose Pages and then select gh-pages as the branch and /root as the location. Mkdocs will produce the website artifacts inside the gh-pages branch and not populalet the main branch with the artifacts in the site folder.