Skip to content

docs: working install URLs, a book sweep, and an English sidebar label - #331

Merged
guillaumejay merged 2 commits into
mainfrom
docs/install-urls
Sep 26, 2026
Merged

guillaumejay merged 2 commits into
mainfrom
docs/install-urls

Conversation

@guillaumejay

Copy link
Copy Markdown
Collaborator

Why

Installing on Linux with the documented one-liner failed:

curl … https://github.com/Termherd/termherd/releases/latest/download/termherd-installer.sh
curl: (22) The requested URL returned error: 404

Two independent causes, either one enough:

  • every release so far is a pre-release, and /releases/latest/ skips
    pre-releases, so it resolves to nothing;
  • dist names the installers after the package: termherd-app-installer.sh /
    .ps1, not termherd-installer.*.

What

Install (README.md, docs/src/guide/installation.md): the one-liners
name the tag and the real file. All three documented URLs checked at 200. The
attestation example used the wrong tarball name too, and the SHA256SUMS it
promised comes from a signing workflow added after v0.1.0-prerelease.4, so
no published release has it yet — the page now says so and points at the
.sha256 / sha256.sum files that do exist.

Book sweep against the source:

  • README live-bridge table lacked prompt_in_session, and still listed it as
    a pending follow-up (F-mcp-agent-loop: composed prompt->wait->read over any session (shell or Claude) #196 shipped it).
  • mcp.allow_claude_nesting was missing from the settings reference, the
    template, the README list, the file-only enumerations and the complete
    example.
  • mcp/keyboard.md: the step field is result, not outcome; the close
    prompt reports as tab-close-confirm; the second rename ignoring enter is
    tab-rename.
  • termherd://keys/schema omits activate-tab-N and shows no default for
    copy / paste; three pages claimed the whole catalogue.
  • snapshot's focused_terminal argument was undocumented.
  • quick-start claimed keyboard resize of splits; nothing resizes them.
  • tabs-and-splits gave Shift+→ for Cmd/Ctrl+Shift+→.
  • chord syntax now lists the modifier aliases and plus.
  • create-missing = false checks SUMMARY.md only, not in-page links.
  • the copy chord asks the terminal for its selection (even scrolled out of
    view) rather than reading the screen.
  • AGENTS.md counted sixteen live-bridge tools; there are seventeen.

Code: the sidebar's collapse button was hard-coded in French
("◀ Masquer le panneau") outside strings.rs; it now reads
strings::SIDEBAR_HIDE = "◀ Hide", as the book shows.

Chore: .serena/ (Serena MCP tool state) is gitignored.

Checks

  • markdownlint-cli2: 0 issues
  • cargo fmt --all --check, cargo clippy -p termherd-app --all-targets -- -D warnings: clean
  • cargo test -p termherd-app: green
  • mdbook build not run locally (not installed) — left to the book job

🤖 Generated with Claude Code

guillaumejay and others added 2 commits September 26, 2026 07:52
The one-line installers pointed at /releases/latest/, which GitHub resolves
to nothing while every release is a pre-release, and at
termherd-installer.{sh,ps1}, while dist names them after the package
(termherd-app-installer.*). Both halves 404'd. The commands now name the tag
and the real file. The attestation example had the same wrong tarball name,
and the SHA256SUMS it promised only exists from the next release onward.

A sweep of the rest of the book against the source fixed:

- README: prompt_in_session missing from the live-bridge table, and still
  listed as a pending follow-up although it shipped (#196).
- The mcp.allow_claude_nesting setting was in none of the settings pages,
  the template, the README list, or the file-only enumerations.
- mcp/keyboard.md: the press step field is `result`, not `outcome`, and the
  close prompt reports as `tab-close-confirm`.
- termherd://keys/schema lists neither activate-tab-N nor a default for
  copy/paste; three pages claimed the whole catalogue.
- snapshot's focused_terminal argument was undocumented.
- quick-start claimed splits resize by keyboard; nothing resizes them.
- tabs-and-splits gave Shift+Right for a Cmd/Ctrl+Shift+Right chord.
- AGENTS.md counted sixteen live-bridge tools; there are seventeen.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The sidebar's collapse button was the one user-facing label left outside
strings.rs, hard-coded in French ("◀ Masquer le panneau") while the book
shows "◀ Hide". It now reads strings::SIDEBAR_HIDE.

Doc wording the audit flagged as doubtful, now settled against the code:

- mcp/keyboard.md: the second rename that ignores `enter` is tab-rename;
  there is no rename in the doc pane.
- contributing.md / book.toml: create-missing = false checks SUMMARY.md
  entries only, not links inside a page.
- reference/keyboard.md: list the modifier aliases and the `plus` key.
- README / terminal.md: the copy chord asks the terminal for its selection,
  including one scrolled out of view, rather than reading the screen.

.serena/ (local state of the Serena MCP tool) is now ignored.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@guillaumejay
guillaumejay merged commit eb2bf4e into main Sep 26, 2026
20 checks passed
@guillaumejay
guillaumejay deleted the docs/install-urls branch September 26, 2026 06:00
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.

1 participant