From c78098bd289d49ff985ca443a370520f033b36a1 Mon Sep 17 00:00:00 2001 From: Johnny Greco Date: Wed, 24 Jun 2026 18:39:57 +0000 Subject: [PATCH] Document GitHub docs workflow --- README.md | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 02fadc82..a52cfc82 100644 --- a/README.md +++ b/README.md @@ -23,6 +23,8 @@ OpenShell as the runtime. Use Python 3.10 or newer. +To preview the documentation locally: + ```sh python3 -m venv .venv source .venv/bin/activate @@ -30,14 +32,21 @@ python -m pip install -r requirements-docs.txt zensical serve ``` -The local preview runs at . To build the static site: +The local preview runs at . To run the same clean build +used by CI: ```sh -python scripts/render-dev-notes.py -zensical build --clean --strict +scripts/build-docs.sh ``` -The generated site is written to `site/`. +The build script recreates `.venv-docs`, installs `requirements-docs.txt`, +renders Dev Notes metadata, and runs `zensical build --clean --strict`. The +generated site is written to `site/`. + +GitHub Actions runs the docs workflow for every pull request and `main` push. +Pull requests validate the generated site without deploying. Pushes to `main` +and manual workflow dispatches from `main` publish `site/` to GitHub Pages +after validation passes. ### Dev Notes