Skip to content

docs: name the portable Windows asset and describe the second-instance message - #1607

Open
mblua wants to merge 1 commit into
mainfrom
docs/1606-portable-asset-and-second-instance
Open

mblua wants to merge 1 commit into
mainfrom
docs/1606-portable-asset-and-second-instance

Conversation

@mblua

@mblua mblua commented Aug 28, 2026

Copy link
Copy Markdown
Owner

Closes #1606.

Documentation catch-up for two changes that landed today. No behavior, workflow, or script change.

What was wrong

The portable download had no name. #1589 shipped agentscommander-X.Y.Z-windows-x86_64-portable.zip, gated so a release without it stays a draft. But docs/quickstart.md still offered "the portable agentscommander.exe", which has never been a published asset. A reader following that instruction downloads the raw agentscommander-windows-x86_64.exe instead, and that name parses as instance suffix 64, silently giving them .agentscommander-windows-x86_64\, an AC [64] badge, a non-default mutex, and ports 9886/9906 instead of 9877/9887. Naming the real asset is what prevents that.

The second-instance behavior changed. #1592 replaced the silent exit(0) with a message explaining the collision and pointing at the rename. packaging/windows/PORTABLE.txt ships inside the zip specifically to explain that scenario and still described the old behavior.

Deliberately not fixed here

Two claims in these same files are inaccurate today. Both are fixed by work in flight, so correcting them now would mean writing the text twice:

Claim Why it waits
README.md:63 "copy the .exe to any drive and it carries its own config" True only where the destination is writable. #1577 adds the probe and the fallback.
docs/features/portable-instances.md:85 "AC keeps no global state outside that directory" The WebView2 user-data folder defaults to %LOCALAPPDATA%\dev.agentscommander.app\ because no builder sets data_directory. #1590 confines it.

macOS and Linux portability wording is untouched for the same reason: each needs #1577 plus a platform-specific bundle-aware resolver branch (#1594 for macOS; the AppImage case is not filed yet). Until those land, an AppImage or a .app is a per-user install rather than a portable one, and the docs should not claim otherwise in either direction.

Verification

  • Four files changed, 10 insertions, 7 deletions.
  • The two deferred claims are confirmed present and unmodified.
  • No page anywhere in README.md or docs/ still offers a portable download by a name that is not a published release asset.
  • bundle-validation runs on this PR because it touches packaging/windows/**, so the reworded PORTABLE.txt is re-packed and re-smoked against a real built binary.

https://claude.ai/code/session_01HydthWuftnNBoYzqHZTNm8

…, refs #1606

Two changes landed today that the docs did not reflect.

#1589 shipped agentscommander-X.Y.Z-windows-x86_64-portable.zip, but
quickstart still offered "the portable agentscommander.exe", an asset
that has never existed. A reader following that downloads the raw
agentscommander-windows-x86_64.exe instead, whose name parses as
instance suffix "64" and silently changes their config directory,
mutex, and ports. README gestured at "portable assets" without naming
one.

#1592 replaced the silent second-instance exit with a message that
explains the collision and points at the rename. PORTABLE.txt ships
inside the zip specifically to explain that scenario and still
described the old behavior.

Deliberately left alone, so they get corrected once rather than twice:

- README "copy the .exe to any drive and it carries its own config",
  true only where the destination is writable, which #1577 fixes.
- portable-instances "AC keeps no global state outside that directory",
  not true while the WebView2 user-data folder defaults to
  %LOCALAPPDATA%, which #1590 fixes.

macOS and Linux portability wording is untouched for the same reason:
each needs #1577 plus a platform-specific bundle-aware resolver branch.

Claude-Session: https://claude.ai/code/session_01HydthWuftnNBoYzqHZTNm8
@sonarqubecloud

Copy link
Copy Markdown

@mblua

mblua commented Oct 23, 2026

Copy link
Copy Markdown
Owner Author

Heads-up: the required checks on main changed (#3184, PR #3185).

The main ruleset now requires these checks instead of the old names:

  • rust-regression is now rust-regression-windows
  • windows-release-cli-smoke is now release-cli-smoke-windows
  • new: issue-1850-release-windows, issue-1850-release-linux, issue-1850-release-macos and rust-slow-test-windows

This branch still runs the old workflow, so those checks never report here and the PR cannot merge as it is.

What to do when this PR is ready to land: wait until PR #3185 is merged, then bring this branch up to date with main (the ruleset already requires that). The new workflow comes with it and reports the new check names. Resolve any conflict in .github/workflows/pr-regression-gates.yml in favour of main.

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.

docs: name the portable Windows asset and describe the new second-instance message

1 participant