docs(readme): describe a released installer, not an unreleased one #19

wtclaude · 2026-08-07T21:07:03Z

wtclaude commented

2026-08-07 21:07:03 +00:00

What & why

The README's status section still opened with "Phases 1 to 4 are built, on the edge branch. Nothing is released yet" and closed with "Until the cutover, the way to install is by hand" — both untrue since #17 merged and cut v0.1.0. This is the repo README: it is the first thing a visitor reads, and it was telling them not to use the tool they came for. PLAN.md §5.4 listed exactly this file as documentation the first release invalidates.

New "Install a shard with it" section, above Status. Verify the checksum, run install as root/Administrator against a stopped shard, paste the four values into Admin → Shard, with a link to the full guide. Someone landing here to use the tool now gets the commands before the project history.
Status → released, with all five phases marked released and both cutover gates recorded, including the Windows SCM half that failed 1053 on its first real run and needed link#29 before it passed 13/13.
Kept the by-hand pointer, reframed. Appendix A is presented as the choice for a host that cannot run the binary or an operator who wants to place files themselves — supported, no longer the default. (Org lead's call: installer for easy mode, hand deployment still supported including on the dev side.)
Fixes a broken link. bundles/current.json was linked relative to the repo root, but published bundle JSON has lived on the bundles branch since #15 — only bundles/README.md is tracked on main. Now points at the bundles branch.

Companion PRs, same branch name in each repo: docs (INSTALL.md/PLAN.md status), link, servuo-plugins, website.

How it was tested

Docs-only, no crate changes — cargo is untouched.

Confirmed via the Gitea API that v0.1.0 exists and carries SHA256SUMS, runicgateway-installer-linux-x86_64, -linux-aarch64 and -windows-x86_64.exe, so the commands in the new section name assets that actually exist.
Confirmed with git ls-files bundles/ that bundles/current.json is not on main, which is what made the old link 404.

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)

AI tools were used. Tool(s): Claude Code. 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 The README's status section still opened with **"Phases 1 to 4 are built, on the `edge` branch. Nothing is released yet"** and closed with **"Until the cutover, the way to install is by hand"** — both untrue since #17 merged and cut [v0.1.0](https://gitea.whitlocktech.com/RunicGateway/installer/releases/tag/v0.1.0). This is the repo README: it is the first thing a visitor reads, and it was telling them not to use the tool they came for. PLAN.md §5.4 listed exactly this file as documentation the first release invalidates. - **New "Install a shard with it" section, above Status.** Verify the checksum, run `install` as root/Administrator against a stopped shard, paste the four values into Admin → Shard, with a link to the full guide. Someone landing here to *use* the tool now gets the commands before the project history. - **Status → released**, with all five phases marked released and both cutover gates recorded, including the Windows SCM half that failed 1053 on its first real run and needed link#29 before it passed 13/13. - **Kept the by-hand pointer, reframed.** Appendix A is presented as the choice for a host that cannot run the binary or an operator who wants to place files themselves — supported, no longer the default. (Org lead's call: installer for easy mode, hand deployment still supported including on the dev side.) - **Fixes a broken link.** `bundles/current.json` was linked relative to the repo root, but published bundle JSON has lived on the `bundles` branch since #15 — only `bundles/README.md` is tracked on `main`. Now points at the `bundles` branch. Companion PRs, same branch name in each repo: docs (INSTALL.md/PLAN.md status), link, servuo-plugins, website. ## How it was tested Docs-only, no crate changes — `cargo` is untouched. - Confirmed via the Gitea API that v0.1.0 exists and carries `SHA256SUMS`, `runicgateway-installer-linux-x86_64`, `-linux-aarch64` and `-windows-x86_64.exe`, so the commands in the new section name assets that actually exist. - Confirmed with `git ls-files bundles/` that `bundles/current.json` is not on `main`, which is what made the old link 404. ## 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) - [x] AI tools were used. Tool(s): `Claude Code`. 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-07 21:07:06 +00:00

docs(readme): describe a released installer, not an unreleased one

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

Details

484f00ddee

The status section still said "Phases 1 to 4 are built, on edge. Nothing
is released yet" and told visitors the way to install was by hand — both
untrue as of v0.1.0.

- Add an "Install a shard with it" section up top: verify, run, paste the
  four values. That is what a visitor to this repo is here for.
- Status: released, all five phases, both cutover gates recorded.
- Fix a broken link: bundles/current.json is no longer on main, it lives
  on the bundles branch.

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

whitlocktech approved these changes 2026-08-07 21:30:34 +00:00

whitlocktech merged commit 7758724eb5 into main

2026-08-07 21:30:41 +00:00

whitlocktech deleted branch docs/installer-first-setup

2026-08-07 21:30:41 +00:00

whitlocktech referenced this issue from a commit

2026-08-07 21:30:42 +00:00

Merge pull request 'docs(readme): describe a released installer, not an unreleased one' (#19) from docs/installer-first-setup into main

Sign in to join this conversation.

2 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: RunicGateway/installer#19