Platform Deployment

Documentation Sites

This repository holds the sources of the platform documentation component; publishing it is the job of the promethistai/promethist-documentation project, which builds two Antora sites from the documentation of all platform repositories:

Site Built from Content

Site	Built from	Content
`https://docs.promethist.dev`	The `main` branch of each repository	Every module of every component it lists — the internal documentation included. It needs no sign-in.
`https://docs.promethist.ai`	Release tags	The user documentation, and of each component it lists only the `public` module, whose index is the component’s start page there.

https://docs.promethist.dev

The main branch of each repository

Every module of every component it lists — the internal documentation included. It needs no sign-in.

https://docs.promethist.ai

Release tags

The user documentation, and of each component it lists only the public module, whose index is the component’s start page there.

Which repositories each site includes is set in the playbooks of the documentation project, not here. A component appears on docs.promethist.ai only once its repository is listed among that site’s sources.

When Changes Appear

Documentation is written on the release branch together with the code it describes and reaches main with the release squash (Release Flow). It appears on docs.promethist.dev with the next build of the documentation project after that, and the public module on docs.promethist.ai with the next tagged release — provided the public site lists this repository.

Trigger Jobs

Two jobs of this repository’s pipeline, in the document stage, trigger the main pipeline of the documentation project:

documentation:site public: Runs on tags. Its changes: docs/** condition always matches in a tag pipeline, so it runs on every release, with the variable SOURCE_TAG={tag}PP. It is the last job of the tag pipeline: when it fails, the pipeline ends as failed even though every deployment succeeded.
documentation:site dev: Meant to run on commits to main that change docs/. The workflow rules of this repository create no pipeline for pushes to main, so it never runs, and the internal site picks up this component’s changes whenever the documentation project rebuilds for another reason.