Skip to content

docs: point every install command at a channel that is published - #63

Merged
LMPrado-DZ23 merged 4 commits into
release/v3.8.55from
docs/published-channels
Sep 20, 2026
Merged

LMPrado-DZ23 merged 4 commits into
release/v3.8.55from
docs/published-channels

Conversation

@LMPrado-DZ23

Copy link
Copy Markdown
Owner

Found while smoke-testing the published image against the deployment path a user would actually follow. Two claims in the docs are false, and both hit a first-time user on the route they are most likely to take.

1. :next in 377 runnable examples

Across the English docs and all 41 locales, the copy-pasteable commands installed ghcr.io/lmprado-dz23/omniroute:next — the mutable pre-release channel, rebuilt on every push to the active release branch.

The Docker guide already says, two sections below:

next is a floating pre-release channel. It may change on any push to the active release branch and is not supported for production use.

…and then uses it in its own Caddy HTTPS auto-TLS recipe, which is the production-behind-a-domain recipe. The policy section was right; every command contradicted it.

Affected: Quick Start, First 10 Minutes, Troubleshooting, Uninstall, VM Deployment Guide, AgentRouter, the podman guide, the hardened-deployment example in SECURITY.md, the Docker guide's Quick Run / env-file / compose / subpath / Caddy blocks — and each one's translation in all 41 locales.

They point at :latest now. :next survives only where the prose documents the pre-release channel on purpose: "Using the pre-release channel", "Safety and rollback", and the README callout. Those were preserved by rule, not by hand — the substitution stops at the Release Channels table, and blockquotes in READMEs are skipped.

The multi-instance compose example pinned a tag that was never published:

docker manifest inspect ghcr.io/lmprado-dz23/omniroute:3.8.49  -> absent
docker manifest inspect ghcr.io/lmprado-dz23/omniroute:latest  -> present

Corrected to :3.8.54.

2. "not published for this fork yet"

The README and the Quick Start told the reader the desktop installer did not exist, and the pt-BR README added that the Docker image might not either:

Desktop installer — not published for this fork yet.
Option A: Desktop app (Windows, macOS, Linux) — not published yet

Release v3.8.54 has been public since 2026-09-19:

tag=v3.8.54 draft=false prerelease=false published=2026-09-19T13:12:57Z assets=15
OmniRoute.Setup.3.8.54.exe   OmniRoute-3.8.54.dmg   OmniRoute-3.8.54-arm64.dmg
OmniRoute-3.8.54.AppImage    OmniRoute-3.8.54-arm64.AppImage
omniroute-desktop_3.8.54_amd64.deb   omniroute-desktop_3.8.54_arm64.deb

Corrected in English and pt-BR.

Honest limit

The other 40 locales still carry the stale "not published yet" sentence. That is translated prose, not a tag substitution, and machine-translating it in 40 languages would trade a visible falsehood for an invisible one. It needs a translation pass; flagging it here rather than hiding it.

Where this came from

A clean container from the published image, checked against the deployment this is meant to support — login required, reachable through a domain:

Probe Result
container health healthy after ~40s
GET /api/settings /providers /keys /workspaces /usage/quota, anonymous 401 each
GET / anonymous 307 → /dashboard → 307 → /login
dashboard HTML before login no provider/key/password strings
POST /api/auth/login wrong password 401
POST /api/auth/login correct password 200, management routes then 200
stored requireLogin true

The image is closed by default. The docs were the weak link, not the artifact.

Gates

Gate Result
check:doc-links PASS — 172 docs, 1044 internal links
check:fabricated-docs no fabricated references
check:docs-sync PASS
check:changelog-integrity OK — no base bullets lost
prettier --check on the edited English docs clean

The changelog entry goes in as a changelog.d/ fragment rather than a CHANGELOG.md edit, to avoid the merge pattern that ate eight sibling bullets on another branch today.

🤖 Generated with Claude Code

Two claims in the docs were false, and both hit a first-time user on the
path they are most likely to take.

1. `:next` in 377 runnable examples

Across the English docs and all 41 locales — the Quick Start, the
first-10-minutes guide, the VM deployment guide, the podman guide, the
hardened-deployment example in SECURITY.md and the Caddy HTTPS recipe —
the copy-pasteable commands installed `:next`. That is the mutable
pre-release channel, rebuilt on every push to the active release branch,
and the Docker guide itself says it is "not supported for production
use" two sections below the recipe that used it.

They use `:latest` now. `:next` survives only where the prose documents
the pre-release channel on purpose ("Using the pre-release channel",
"Safety and rollback", and the README callout).

The multi-instance compose example pinned `omniroute:3.8.49`, which was
never published:

  docker manifest inspect ghcr.io/lmprado-dz23/omniroute:3.8.49 -> absent
  docker manifest inspect ghcr.io/lmprado-dz23/omniroute:latest   -> present

Corrected to `:3.8.54`.

2. "not published for this fork yet"

The README and the Quick Start told the reader the desktop installer did
not exist and the Docker image might not either. Release v3.8.54 has been
public since 2026-09-19 with 15 assets (.exe, .dmg, .AppImage, .deb, x64
and arm64), and `:latest` pulls. Corrected in English and pt-BR; the
other 40 locales still carry the stale sentence and need a translation
pass — recorded in the PR rather than machine-translated here.

  [doc-links] PASS — 172 docs, 1044 internal links
  [fabricated-docs] no fabricated references
  [docs-sync] PASS   [changelog-integrity] OK
  prettier --check on the edited English docs — clean

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

coderabbitai Bot commented Sep 20, 2026 •

Copy link
Copy Markdown

Important

  • 🔍 Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Advanced

Run ID: 2faa24d0-67e2-40c0-905a-02bee1c9eb23


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

zodyprado-web and others added 3 commits September 20, 2026 00:02
The stale sentences this PR fixes did not appear by accident: nothing in
the release process re-reads the prose that says what exists, so it rots
one release at a time and only a reader notices.

Adds a "Claims the release makes stale" step between Version & Changelog
and Code Quality, with the command that checks each one:

  - "not published yet" in README / QUICK-START, against
    gh release view <tag> --json assets
  - runnable examples must install :latest or :X.Y.Z, never :next
  - pinned example tags must resolve (docker manifest inspect)
  - the same sentences in the 41 locales, with the honest note that
    changed prose needs a translation pass

  [doc-links] PASS   [fabricated-docs] clean   prettier --check clean

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
The base file was prettier-clean; my added block was not.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants