docs(readme): say how to get a sidecar before explaining how it is used #120

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

wtclaude commented

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

What & why

The Shard integration (uo-link) section documents the contract thoroughly — ingest, REST, the SSE split, ownership checks — but never answered the question an admin actually arrives with: where do the base URL, WebSocket URL, protocol version and token in Admin → Shard come from? The README pointed at RunicGateway/link for the source, which is a repo to build, not an answer.

They come from the installer, released as v0.1.0 on 2026-08-07: it runs on the shard host, deploys the plugin and sidecar as a matched protocol-checked pair, registers the service, and prints those four values at the end of the run.

Adds a short "Setting up the shard side" subsection ahead of "How it works" with that flow, the shape of the printed block, a link to INSTALL.md, and a pointer to Appendix A for the by-hand path (still supported — for a host that cannot run the binary or a developer working from a source tree). Also restates that none of it is required: with no sidecar configured the site renders normally and shows the shard offline.

README-only — no routes, controllers, models, schema or client code touched, so no OpenAPI regeneration is involved.

How it was tested

Docs-only; nothing to run. The printed block matches the token-handoff format in docs/installer/PLAN.md §6, and protocol 3 matches the current bundle (2026.08.07: link v1.2.1, overlay v0.2.0).

Companion PRs, same branch name in each repo: docs, installer, link, servuo-plugins.

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 **Shard integration (uo-link)** section documents the contract thoroughly — ingest, REST, the SSE split, ownership checks — but never answered the question an admin actually arrives with: *where do the base URL, WebSocket URL, protocol version and token in Admin → Shard come from?* The README pointed at `RunicGateway/link` for the source, which is a repo to build, not an answer. They come from the [installer](https://gitea.whitlocktech.com/RunicGateway/installer), released as v0.1.0 on 2026-08-07: it runs on the shard host, deploys the plugin and sidecar as a matched protocol-checked pair, registers the service, and **prints those four values at the end of the run**. Adds a short "Setting up the shard side" subsection ahead of "How it works" with that flow, the shape of the printed block, a link to INSTALL.md, and a pointer to Appendix A for the by-hand path (still supported — for a host that cannot run the binary or a developer working from a source tree). Also restates that none of it is required: with no sidecar configured the site renders normally and shows the shard offline. README-only — no routes, controllers, models, schema or client code touched, so no OpenAPI regeneration is involved. ## How it was tested Docs-only; nothing to run. The printed block matches the token-handoff format in `docs/installer/PLAN.md` §6, and protocol 3 matches the current bundle (`2026.08.07`: link v1.2.1, overlay v0.2.0). Companion PRs, same branch name in each repo: docs, installer, link, servuo-plugins. ## 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:08:00 +00:00

docs(readme): say how to get a sidecar before explaining how it is used

PR Checks / bot-install (pull_request) Successful in 22s

Details

PR Checks / server-tests (pull_request) Successful in 1m57s

Details

PR Checks / client-build (pull_request) Successful in 9m6s

Details

03534c8db1

The shard integration section documented the contract in detail but never
told an admin where the base URL, WS URL, protocol version and token come
from. They come from the installer, which prints them at the end of a run.

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

whitlocktech approved these changes 2026-08-07 21:31:13 +00:00

whitlocktech merged commit d765280e28 into main

2026-08-07 21:31:19 +00:00

whitlocktech deleted branch docs/installer-first-setup

2026-08-07 21:31:20 +00:00

whitlocktech referenced this issue from a commit

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

Merge pull request 'docs(readme): say how to get a sidecar before explaining how it is used' (#120) 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/website#120