Deployment View

Infrastructure Level 1

Overview

ProductShape has two delivery forms: the npm-distributed CLI used in adopter repositories, and this repository's static public documentation site. The site build also generates and includes a read-only Product Snapshot. No ProductShape application server is deployed.

Topology Rationale

The CLI runs locally in the repository it operates on. GitHub Actions builds the documentation site from tracked sources and deploys static output to GitHub Pages after a merge to main or a manual workflow dispatch.

Quality and Performance Characteristics

Static hosting avoids a runtime service for public documentation. The explorer file remains self-contained and read-only. The npm package bundles its runtime dependencies and CLI assets.

Building Block Mapping

Building block or artifactInfrastructure elementEnvironment
@prodshape/cli and bundled packagesnpm registry; installed into adopter repositoryConsumer development and CI
Product model, source, schemas, docsGit repositoryAuthoring and review
Snapshot generator and site builderGitHub Actions runnerBuild job
_site/ static outputGitHub PagesPublic documentation
Generated model explorer_site/en/model/explorer.htmlPublic, read-only model view

Infrastructure Level 2

The GitHub Pages workflow installs workspace dependencies, builds the CLI packages, generates the snapshot from docs/product/model, assembles the complete static site, uploads one Pages artifact, and deploys that artifact. Deployment concurrency ensures one active Pages publish for this repository.