Getting started¶
These pages are the public view of the Customer Intelligence Platform. You can read them without a cluster and without the private component repositories.
Preview the site¶
From a checkout of the integration repository, with uv installed:
make docs-serve installs the locked documentation tools and serves this site with live reload at http://127.0.0.1:8000. It does not check out the component repositories.
Two related targets:
make docs-build writes a strict production build to site/. make docs-check runs that build, then checks that the public pages stay inside docs/public/ and that the generated site does not contain private operational material.
Offline checks¶
make check lints and runs the offline tests. It does not need the component checkouts, and it does not contact the cluster.
What lives where¶
docs/public/is the only tree this site builds.- Notes under
docs/outside that directory are internal and are not published. - Simulator, cluster, and lakehouse implementation stay in their own repositories. This repository pins those commits and holds the cross-component checks.
A reader of this site does not need those repositories to follow the architecture or the data flow.