File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -15,6 +15,22 @@ This repository publishes docs previews for pull requests under:
1515 - removes ` previews/pr-<number>/ ` by pushing directly to ` gh-pages ` as the Scribbler app,
1616 - deletes all preview deployments and the preview environment.
1717
18+ ## Flow diagram
19+
20+ ``` mermaid
21+ flowchart TD
22+ A[Contributor opens or updates PR to main] --> B[Docs workflow builds preview site]
23+ B --> C[Scribbler app token pushes preview files to gh-pages under previews/pr-N]
24+ C --> D[Workflow sets environment pr-preview-N with preview URL]
25+ D --> E[Workflow comments on PR with preview link]
26+ E --> F[Contributor iterates on PR]
27+ F --> B
28+ G[PR closed: merged or abandoned] --> H[Cleanup job runs]
29+ H --> I[Scribbler app token removes previews/pr-N from gh-pages]
30+ I --> J[Workflow deletes preview deployments + environment]
31+ J --> K[Workflow updates PR comment: preview removed]
32+ ```
33+
1834## Required repository configuration
1935
20361 . Ensure ` gh-pages ` branch exists.
You can’t perform that action at this time.
0 commit comments