docs: converge operator guidance on tht
This commit is contained in:
@@ -31,7 +31,7 @@
|
||||
- Modify the `Target.Source` comment in `tools/thothctl/internal/pi/state.go` when `"restart"` becomes a valid non-image lifecycle source.
|
||||
- Modify `tools/thothctl/cmd/thothctl/main.go` and its test for usage, parsing, dispatch, and recovery.
|
||||
- Modify `frontend/src/shell/PiManagement.tsx` and its test for the structured workflow.
|
||||
- Modify `docs/contracts/thothctl-pi.md`, `docs/install/pi-management.md`, `docs/general/pi-configuration.md`, and `scripts/verify-workspace-install-docs.sh`.
|
||||
- Modify `docs/contracts/tht-pi.md`, `docs/install/pi-management.md`, `docs/general/pi-configuration.md`, and `scripts/verify-workspace-install-docs.sh`.
|
||||
- Modify `README.md` only if it claims to list the complete Pi command surface.
|
||||
|
||||
---
|
||||
@@ -440,7 +440,7 @@ git commit -m "feat(thothctl): expose Pi restart command"
|
||||
### Task 4: Update contracts, operator docs, and documentation gates
|
||||
|
||||
**Files:**
|
||||
- Modify: `docs/contracts/thothctl-pi.md`
|
||||
- Modify: `docs/contracts/tht-pi.md`
|
||||
- Modify: `docs/install/pi-management.md`
|
||||
- Modify: `docs/general/pi-configuration.md`
|
||||
- Modify: `scripts/verify-workspace-install-docs.sh:1160-1188`
|
||||
@@ -484,7 +484,7 @@ Expected: FAIL because restart and separated workflows are not documented.
|
||||
|
||||
- [ ] **Step 3: Rewrite the two authoritative operator documents**
|
||||
|
||||
In `docs/contracts/thothctl-pi.md`, document `pi restart --yes [--drain]`, confirmation, maintenance, bounded drain, current-image retention, core-only recreation, verification, separate restart state, shared lock, and recovery.
|
||||
In `docs/contracts/tht-pi.md`, document `pi restart --yes [--drain]`, confirmation, maintenance, bounded drain, current-image retention, core-only recreation, verification, separate restart state, shared lock, and recovery.
|
||||
|
||||
In `docs/install/pi-management.md`, use these headings:
|
||||
|
||||
@@ -519,7 +519,7 @@ Expected: both exit 0.
|
||||
- [ ] **Step 6: Commit**
|
||||
|
||||
```bash
|
||||
git add docs/contracts/thothctl-pi.md docs/install/pi-management.md docs/general/pi-configuration.md scripts/verify-workspace-install-docs.sh
|
||||
git add docs/contracts/tht-pi.md docs/install/pi-management.md docs/general/pi-configuration.md scripts/verify-workspace-install-docs.sh
|
||||
git commit -m "docs: clarify Pi reload and update workflows"
|
||||
```
|
||||
|
||||
|
||||
Reference in New Issue
Block a user