Skip to content

Commit d335428

Browse files
author
Thomas Cooper
committed
docs: clarify demo descriptions — API approval is for demo automation only
1 parent 921124d commit d335428

1 file changed

Lines changed: 9 additions & 3 deletions

File tree

DEMO.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,11 @@
44

55
## 1. Store-and-forward: successful push (all green)
66

7-
A clean commit pushed through the `/push/` path. All validation checks pass and the push is forwarded upstream
8-
automatically.
7+
A clean commit pushed through the `/push/` path. All validation checks pass, the push waits for review, and is forwarded
8+
upstream on approval.
9+
10+
> **Note:** API approval via admin key is used here for demonstration purposes — approval is normally performed through
11+
> the dashboard UI.
912
1013
[Watch: push_mode_pass_email_unregistered.webm](demos/push_mode_pass_email_unregistered.webm)
1114

@@ -22,7 +25,10 @@ containing an internal hostname, and a leaked secret detected by secret scanning
2225

2326
## 3. Transparent proxy: golden-path push
2427

25-
A push through the `/proxy/` path. Validation passes and the push is forwarded immediately with no review step.
28+
A push through the `/proxy/` path. Validation passes, the push waits for review, and is forwarded upstream on approval.
29+
30+
> **Note:** API approval via admin key is used here for demonstration purposes — approval is normally performed through
31+
> the dashboard UI.
2632
2733
![Proxy mode — golden path](demos/demo-proxy-pass.gif)
2834

0 commit comments

Comments
 (0)