Skip to content

About

Landing page, guide and code reference of Pill

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

Pill Engine Website

This repository builds and deploys the Pill landing page and documentation:

And

Development

  • npm run dev - Start both the landing page and docs development servers.
  • npm run build - Build the landing page into dist/ and the docs into dist-docs/ (this is what CI runs before deploying).
  • npm run preview - Preview the landing page production build.
  • npm run install:all - Install dependencies for both workspace projects.

Documentation generation

docs_page/ builds the VitePress site from two sources:

  • Current guide - authored in this repository, under docs_page/pages/guide_current/ and served at /guide_current/.
  • Experimental guide and API reference - authored in Pillware/Pill-Docs (guide/ and reference/, including their sidebar files), not here. The reference has ~3,850 generated pages.

npm run docs:update-reference (run in docs_page/) mirrors them into docs_page/pages/guide/ and docs_page/pages/reference/ and records the source commit and date in docs_page/.vitepress/content-version.json. These targets are generated and git ignored, and docs:dev/docs:build never sync on their own. Every build publishes that record as build-info.json at the site root, which is also what the deploy workflow reads to decide whether anything changed.

Trigger How
Local In docs_page: npm run docs:update-reference and npm run docs:build; then from the repository root: node build-script.js docs
Site change push to main touching docs_page/**, pill_style.css or build-script.js
Content change Pill-Docs sends the pill-docs-updated repository_dispatch
Daily scheduled run at 04:17 UTC, skipped when the live build-info.json already matches Pill-Docs main
Manual Actions → Deploy Docs → Run workflow (content_ref, refresh_content, deploy)

When Pill-Docs cannot be read, the last cached content is reused; when nothing is cached, the workflow leaves the live docs untouched instead of deploying an incomplete site.

For documentation structure and generation details, see docs_page/README.md.

About

Landing page, guide and code reference of Pill

Resources

Stars

0 stars

Watchers

0 watching

Forks

Contributors

Languages