Publishing
Purpose
Section titled “Purpose”Document how the public GitHub Pages site is built and deployed.
Publication Model
Section titled “Publication Model”- Repository owner:
t3lstar. - Repository:
PC-Build. - Public site URL:
https://t3lstar.github.io/PC-Build/. - Pull requests validate and build the Starlight site, but do not deploy it.
- Pushes to
mainvalidate, build, and deploy the Starlight site to GitHub Pages. - The deployment workflow adds
.nojekyllto the published output.
Local Build
Section titled “Local Build”Use the single parameterized build script:
./scripts/build.sh htmlSupported targets:
./scripts/build.sh html./scripts/build.sh pdf./scripts/build.sh printable./scripts/build.sh allThe pdf target is deferred by project decision. The printable target builds the Starlight site and relies on browser print styles.
Environment Expectations
Section titled “Environment Expectations”| Tool | Target |
|---|---|
| Node.js | 24 |
| Python | 3.12 |
| Python environment | Local .venv |
| Starlight output | dist/ |
| Published route | https://t3lstar.github.io/PC-Build/ |
| Digital twin route | /digital-twin/first-slice/ |
| Public assets | public/assets/ copied into dist/assets/ |
dist/, site/, and build/ are generated outputs and should not be committed.
GitHub Actions Flow
Section titled “GitHub Actions Flow”- Pull request or push to
mainstarts the workflow. - GitHub Actions checks out the repository.
- Python 3.12 dependencies are installed from
requirements.txt. - Node.js 24 dependencies are installed from
package-lock.json. ./scripts/validate.sh allvalidates data, QR assets, Markdown, Astro/Starlight types, static output, routes, links, and critical assets..nojekyllis added todist/.- Pull request workflow stops after validation.
- Push to
mainuploadsdist/as the GitHub Pages artifact. - GitHub Pages serves the deployed site at the public URL.
Verification
Section titled “Verification”- Local
./scripts/validate.sh allsucceeds. - Local
./scripts/build.sh htmlsucceeds. - GitHub Actions validation succeeds.
- The deployed site returns HTTP 200.
- The deployed digital twin returns HTTP 200 at
https://t3lstar.github.io/PC-Build/digital-twin/first-slice/. - Navigation includes all chapter and appendix pages.
.nojekyllis included in the deployed output.