AqueductHub / aqueductcore

Aqueduct Core is responsible for the core functionality of Aqueduct, an experiment management system.
https://aqueducthub.github.io/aqueductcore/
MIT License
23 stars 3 forks source link

Documentation preview per pull requestion with URL commented #112

Closed samiralavi closed 1 month ago

samiralavi commented 1 month ago

The documentation of Aqueduct can not be previewed in a PR that has changed the docs because there is no staging environment or workflow for that. An idea taken from FastAPI repository is to use Cloudflare Pages service which is a free service to host staging static website. Further information about how it works is here:

https://github.com/cloudflare/pages-action https://github.com/tiangolo/fastapi/blob/master/.github/workflows/deploy-docs.yml