Umbrella site for OWID's technical documentation.
Production URL during the parallel-hosting phase: https://docs-cf.owid.io/. The current production URL on ReadTheDocs is unchanged: https://docs.owid.io/.
docs/ |
Source markdown for the umbrella landing page + links into subprojects |
zensical.toml |
Site config (Zensical / Material) |
_worker.js |
Cloudflare Pages worker — proxies subproject paths to other Pages projects (/projects/etl/*, /projects/owid-grapher-py/*, …) |
.github/workflows/deploy-docs-cf.yml |
Builds + deploys this site to Cloudflare Pages on every push to main |
.github/workflows/docs.yml |
Legacy GitHub Pages deploy (will be removed after the RtD cut-over) |
.readthedocs.yml |
RtD build config (unchanged during the transition) |
INFRASTRUCTURE.md |
How the CF deployment fits together + how to add a new subproject |
uv sync
uv run zensical serve # http://localhost:8000
uv run zensical build --clean # output: site/Pushes to main deploy to the owid-docs Cloudflare Pages project. PRs get per-PR preview URLs at <branch>.owid-docs.pages.dev.
For the full picture — adding a new subproject, swapping the custom domain, cache-purge ops — see INFRASTRUCTURE.md.