cicd-sensor.github.io

Source for the cicd-sensor documentation site.

This repository owns the mdbook configuration, theme, and deployment pipeline. The markdown content itself lives in the main repository under docs/ and is pulled in at build time.

Prerequisites: mdbook and mdbook-mermaid on PATH (cargo install mdbook mdbook-mermaid).

Local development

Clone both repositories as siblings:

git clone https://github.com/cicd-sensor/cicd-sensor.git
git clone https://github.com/cicd-sensor/cicd-sensor.github.io.git

Then from this repository:

./serve.sh

mdbook serve opens http://127.0.0.1:3000 with live reload on changes to:

• ../cicd-sensor/docs/ (markdown content from the main repo)
• ./theme/ (site theme owned by this repo)

Override the default sibling path with SRC=path/to/docs ./serve.sh.

Deployment

Pushes to main and repository_dispatch events from the main repository trigger .github/workflows/deploy.yml, which checks out both repositories, runs mdbook build, and deploys the rendered book to GitHub Pages.

Layout

Path	Owner	Purpose
book.toml	this repo	mdbook configuration
theme/	this repo	site theme overrides
serve.sh	this repo	local live-reload preview
.github/workflows/	this repo	build and deploy pipeline
build/src/	generated at build time	markdown copied from the main repo