Automatically publish docs under GitHub

[gpsaggese]

We want to have a GH action that automatically publishes the documentation from docs to GitHub

I've published manually the //helpers one https://causify-ai.github.io/helpers/

We want to

• Add the GH action to the template repo since pretty much any repo should have its own documentation
• Add the action to helpers and cmamp

There is some documentation under ./docs/documentation_meta/all.mkdocs_deployment.how_to_guide.md

The section # MkDocs documentation deployment should be updated with the new flow

Then we want to

• add a note in the dev-system paper
• send an email to the team with the usual information about a new dev-system version deploy

[Shayawnn]

• and cmamp

@gpsaggese Publicly exposed, or private?

[gpsaggese]

It should follow the repo setting, e.g., a public repo -> public, private repo -> private. Using GH pages should follow exactly those params, but pls let's double check. (See the doc I've put together while building a prototype).

[heanhsok]

1. Workflow to publish mkdocs for //helpers automatically daily onto Github Page
   • PR: HelpersTask914_Automatically_publish_docs_under_GitHub
   • Workflow run: https://github.com/causify-ai/helpers/actions/runs/16152071970/job/45585549138
2. To publish a GH page privately, we need to have GitHub Enterprise Cloud according to About access control for GitHub Pages sites, so we can't use GH pages for //cmamp ATM.
   • The workaround is to host the static site (e.g. https://docs.causify.ai/) on our infra (e.g,. an S3 bucket) and make it accessible only via our VPN. We can have a similar workflow that publishes the content to the S3 bucket

WDYT? @gpsaggese @Shayawnn

[gpsaggese]

2. Publish privately

The proposal sounds good to me. Can we do something like docs.causify.ai/cmamp so we can have multiple repos / documentation projects hosted under one place?

The public ones can be hosted on GH pages.