Skip to content

Commit 24095bb

Browse files
committed
docs: defer service activation until validation
1 parent abf916e commit 24095bb

3 files changed

Lines changed: 25 additions & 4 deletions

File tree

README.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -268,7 +268,6 @@ Install the system service for a dedicated user named `encoder`:
268268
```bash
269269
sudo install -m 0644 systemd/youtube-autoencoder@.service /etc/systemd/system/youtube-autoencoder@.service
270270
sudo systemctl daemon-reload
271-
sudo systemctl enable --now youtube-autoencoder@encoder.service
272271
```
273272

274273
For a user service instead:
@@ -277,9 +276,10 @@ For a user service instead:
277276
mkdir -p ~/.config/systemd/user
278277
cp systemd/user/youtube-autoencoder.service ~/.config/systemd/user/
279278
systemctl --user daemon-reload
280-
systemctl --user enable --now youtube-autoencoder.service
281279
```
282280

281+
The unit is installed but deliberately left disabled until OAuth, source, ingest, and visible-stream validation succeed.
282+
283283
For Raspberry Pi specific notes, see `docs/raspberry-pi.md`.
284284

285285
## Configuration Model
@@ -450,6 +450,20 @@ YTA_INSTANCE_ID=encoder-hostname youtube-autoencoder-api run-visible-test \
450450

451451
This validates OAuth, reusable-stream provisioning, idempotent broadcast reconciliation, stream binding, ingest detection, transitions to `testing` and `live`, and explicit completion. The normal unattended service never completes on exit.
452452

453+
### 8. Enable the Service
454+
455+
After visible validation succeeds, enable the system service:
456+
457+
```bash
458+
sudo systemctl enable --now youtube-autoencoder@encoder.service
459+
```
460+
461+
For a user service instead:
462+
463+
```bash
464+
systemctl --user enable --now youtube-autoencoder.service
465+
```
466+
453467
### Common Authorization Problems
454468

455469
| Symptom | Likely cause | Fix |

docs/superpowers/plans/2026-07-10-readme-architecture-diagrams.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -267,7 +267,11 @@ flowchart TD
267267
```
268268
````
269269

270-
- [ ] **Step 3: Validate the approved diagram count and deployment branches**
270+
- [ ] **Step 3: Align service activation with successful validation**
271+
272+
Remove both `enable --now` commands from the initial unit-install examples. State that the units remain disabled during provisioning, then add a post-validation section that enables either the system or user service only after the visible test succeeds.
273+
274+
- [ ] **Step 4: Validate the approved diagram count and deployment branches**
271275

272276
Run:
273277

@@ -277,12 +281,13 @@ test "$(rg -c '^flowchart TB$' README.md)" -eq 1
277281
test "$(rg -c '^flowchart TD$' README.md)" -eq 1
278282
test "$(rg -c '^stateDiagram-v2$' README.md)" -eq 1
279283
rg -n 'DeploymentStreamDecision|DeploymentValidationDecision|DeploymentDiagnose --> DeploymentStreamDecision|remote-management recovery' README.md
284+
rg -n 'left disabled|### 8\. Enable the Service|enable --now youtube-autoencoder' README.md
280285
git diff --check
281286
```
282287

283288
Expected: exactly three approved Mermaid blocks, exactly one of each diagram type, both decision IDs found, and zero diff-check errors.
284289

285-
- [ ] **Step 4: Commit the deployment flow**
290+
- [ ] **Step 5: Commit the deployment flow**
286291

287292
```bash
288293
git add README.md

docs/superpowers/specs/2026-07-10-readme-architecture-diagrams-design.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,8 @@ Decision nodes will identify the two operator-significant branches:
9797

9898
The detailed README text will state that `--create-stream` requires an existing writable OBS service file with a non-empty placeholder key. A validation failure returns to the reusable-stream decision so provisioning is retried when the prior attempt did not create a stream.
9999

100+
Command-level instructions must follow the same order as the diagram: install the systemd unit during host setup, but do not enable or start it until OAuth, source, ingest, and visible-stream validation have succeeded.
101+
100102
The existing numbered OAuth section remains the source of command and console detail.
101103

102104
## Mermaid Conventions

0 commit comments

Comments
 (0)