docs: converge operator guidance on tht
This commit is contained in:
@@ -371,7 +371,7 @@ git commit -m "feat: add cross-platform thothctl"
|
||||
- Test: `tools/thothctl/internal/pi/commands_test.go`
|
||||
- Test: `tools/thothctl/internal/pi/update_test.go`
|
||||
- Modify: `tools/thothctl/cmd/thothctl/main.go`
|
||||
- Create: `docs/contracts/thothctl-pi.md`
|
||||
- Create: `docs/contracts/tht-pi.md`
|
||||
|
||||
**Interfaces:**
|
||||
- Produces: `pi status|doctor|configure|test|update|logs`.
|
||||
@@ -405,7 +405,7 @@ Record current image ID, pull/build requested pinned version, recreate only `cor
|
||||
```sh
|
||||
docker run --rm -v "$PWD:/src" -w /src/tools/thothctl golang:1.24 go test ./internal/pi -v
|
||||
docker run --rm -v "$PWD:/src" -w /src/tools/thothctl golang:1.24 go test ./...
|
||||
git add tools/thothctl docs/contracts/thothctl-pi.md
|
||||
git add tools/thothctl docs/contracts/tht-pi.md
|
||||
git commit -m "feat: manage embedded pi with thothctl"
|
||||
```
|
||||
|
||||
|
||||
@@ -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"
|
||||
```
|
||||
|
||||
|
||||
@@ -25,7 +25,7 @@
|
||||
- Modify `tools/thothctl/cmd/thothctl/main.go` and `main_test.go` for optional global selection, `pi update` defaults, help text, and dispatch.
|
||||
- Create `tools/thothctl/internal/pi/version.go` and `version_test.go` for reading the project Pi pin.
|
||||
- Modify `tools/thothctl/internal/pi/update.go` and `update_test.go` only if the default request needs a typed source/confirmation adjustment; keep lifecycle internals unchanged otherwise.
|
||||
- Modify `docs/contracts/thothctl-pi.md`, `docs/install/pi-management.md`, and relevant command-contract verification scripts.
|
||||
- Modify `docs/contracts/tht-pi.md`, `docs/install/pi-management.md`, and relevant command-contract verification scripts.
|
||||
|
||||
### Task 1: Add bounded installation descriptor discovery
|
||||
|
||||
@@ -70,7 +70,7 @@
|
||||
### Task 4: Update contracts without removing commands
|
||||
|
||||
**Files:**
|
||||
- Modify: `docs/contracts/thothctl-pi.md`
|
||||
- Modify: `docs/contracts/tht-pi.md`
|
||||
- Modify: `docs/install/pi-management.md`
|
||||
- Modify: the documentation verification script that asserts the old mandatory update invocation.
|
||||
|
||||
|
||||
@@ -988,7 +988,7 @@ git commit -m "feat(frontend): simplify Pi management guidance"
|
||||
|
||||
**Files:**
|
||||
|
||||
- Rename: `docs/contracts/thothctl-pi.md` → `docs/contracts/tht-pi.md`
|
||||
- Rename: `docs/contracts/tht-pi.md` → `docs/contracts/tht-pi.md`
|
||||
- Modify: `README.md`
|
||||
- Modify: `PROJECT_STATE.md`
|
||||
- Modify: `AGENTS.md`
|
||||
|
||||
@@ -170,7 +170,7 @@ GUI workflow.
|
||||
|
||||
## Documentation changes
|
||||
|
||||
- Update `docs/contracts/thothctl-pi.md` with the restart safety and recovery contract.
|
||||
- Update `docs/contracts/tht-pi.md` with the restart safety and recovery contract.
|
||||
- Update `docs/install/pi-management.md` to separate GUI defaults, configuration reload, version
|
||||
update, and failure recovery.
|
||||
- Add a prominent ThothII-operator note to `docs/general/pi-configuration.md`: native Pi paths
|
||||
|
||||
Reference in New Issue
Block a user