docs(readme): describe the tool that exists, not Phase 1 #12

wtclaude · 2026-08-05T10:52:52Z

wtclaude commented

2026-08-05 10:52:52 +00:00

What & why

PLAN.md §5.4 — the docs a first release invalidates. The status section still announced Phase 1 as built and Phase 2 as next, four phases later. It is the first thing a visitor to this repo reads, and it has been wrong since Phase 2 merged.

The phase table shows 1–4 built on edge and 5 in progress, and the opening paragraph says what the binary actually does.
"What the cutover is waiting on" is now stated. "Nothing is released yet" invites exactly that question, and the answer is two specific things: Phase 5, and the Windows SCM half never having been executed anywhere. Someone landing here should not have to open the plan to find that out.
"Planned commands" → "Commands." All four are implemented.
RUNICGATEWAY_STATE_DIR was described as relocating install.json. Since Phase 2 it relocates everything the installer writes — including the sidecar binary — and suppresses service registration. An out-of-date description of where a tool writes is worse than none, since it is the variable people reach for to test a run without root.
A design-constraint bullet for the backup behaviour (installer#11).

Scope note

Edited on edge only. main's copy is the same stale file and is corrected by the cutover merge; editing both would just create a conflict to resolve there for no gain in the meantime.

The matching INSTALL.md half — the aarch64 download lines, the backup behaviour and --no-backup — is in the docs repo, in the same PR as the §5.3 correction.

How it was tested

Prose only; every claim is checked against this branch's code (paths::layout's relocation behaviour, cli::USAGE's four commands, and the phase state of edge).

Checklist

I have read CONTRIBUTING.md.
The change builds and existing tests/checks pass locally.
I have added or updated tests/docs where it makes sense.
My commits are reasonably scoped with clear messages.

AI-assisted contributions (required)

No AI tools were used to produce this contribution.
AI tools were used. Tool(s): Claude Code (Opus 5). I have reviewed and understand every change, and take responsibility for it. AI-authored commits are marked with a Co-Authored-By trailer.

License

I agree that my contribution is licensed under this project's license (GNU GPL v3.0 or later), and I have the right to contribute it.

## What & why [PLAN.md §5.4](https://gitea.whitlocktech.com/RunicGateway/docs/src/branch/main/installer/PLAN.md) — the docs a first release invalidates. The status section still announced **Phase 1 as built and Phase 2 as next**, four phases later. It is the first thing a visitor to this repo reads, and it has been wrong since Phase 2 merged. - The phase table shows 1–4 built on `edge` and 5 in progress, and the opening paragraph says what the binary actually does. - **"What the cutover is waiting on" is now stated.** "Nothing is released yet" invites exactly that question, and the answer is two specific things: Phase 5, and the Windows SCM half never having been executed anywhere. Someone landing here should not have to open the plan to find that out. - **"Planned commands" → "Commands."** All four are implemented. - **`RUNICGATEWAY_STATE_DIR` was described as relocating `install.json`.** Since Phase 2 it relocates everything the installer writes — including the sidecar binary — and suppresses service registration. An out-of-date description of where a tool writes is worse than none, since it is the variable people reach for to test a run without root. - A design-constraint bullet for the backup behaviour (installer#11). ## Scope note Edited on `edge` only. `main`'s copy is the same stale file and is corrected by the cutover merge; editing both would just create a conflict to resolve there for no gain in the meantime. The matching `INSTALL.md` half — the `aarch64` download lines, the backup behaviour and `--no-backup` — is in the docs repo, in the same PR as the §5.3 correction. ## How it was tested Prose only; every claim is checked against this branch's code (`paths::layout`'s relocation behaviour, `cli::USAGE`'s four commands, and the phase state of `edge`). ## Checklist - [x] I have read [CONTRIBUTING.md](CONTRIBUTING.md). - [x] The change builds and existing tests/checks pass locally. - [x] I have added or updated tests/docs where it makes sense. - [x] My commits are reasonably scoped with clear messages. ## AI-assisted contributions (required) - [ ] No AI tools were used to produce this contribution. - [x] AI tools were used. Tool(s): `Claude Code (Opus 5)`. I have reviewed and understand every change, and take responsibility for it. AI-authored commits are marked with a `Co-Authored-By` trailer. ## License - [x] I agree that my contribution is licensed under this project's license (**GNU GPL v3.0 or later**), and I have the right to contribute it.

wtclaude added 1 commit 2026-08-05 10:52:54 +00:00

docs(readme): describe the tool that exists, not Phase 1

PR Checks / rust-gates (pull_request) Successful in 1m0s

Details

c79374ff06

PLAN.md §5.4. The status section still announced Phase 1 as built and
Phase 2 as next, four phases later -- it is the first thing a visitor to
this repo reads, and it has been wrong since Phase 2 merged.

- The phase table now shows 1-4 built on `edge` and 5 in progress, and
  the opening says what the binary actually does.
- "What the cutover is waiting on" is stated, because "nothing is
  released yet" invites the question: Phase 5, and the Windows SCM half
  never having been executed anywhere.
- "Planned commands" is now "Commands". All four are implemented.
- RUNICGATEWAY_STATE_DIR was described as relocating install.json. Since
  Phase 2 it relocates everything the installer writes, including the
  sidecar binary, and suppresses service registration -- an out-of-date
  description of where a tool writes is worse than none.
- A design-constraint bullet for the backup behaviour Phase 5 adds.

Co-Authored-By: Claude <noreply@anthropic.com>

whitlocktech merged commit 461192a470 into edge

2026-08-05 17:51:33 +00:00

whitlocktech referenced this issue from a commit

2026-08-05 17:51:34 +00:00

Merge pull request 'docs(readme): describe the tool that exists, not Phase 1' (#12) from docs/readme-and-install-refresh into edge

whitlocktech deleted branch docs/readme-and-install-refresh

2026-08-05 17:51:34 +00:00

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: RunicGateway/installer#12