Skip to content

docs: make GitHub Releases the primary install path#2495

Merged
illegalcall merged 4 commits into
AgentWrapper:mainfrom
harshitsinghbhandari:ao/agent-orchestrator-36/docs-releases-install
Jul 9, 2026
Merged

docs: make GitHub Releases the primary install path#2495
illegalcall merged 4 commits into
AgentWrapper:mainfrom
harshitsinghbhandari:ao/agent-orchestrator-36/docs-releases-install

Conversation

@harshitsinghbhandari

Copy link
Copy Markdown
Collaborator

What

The @aoagents/ao npm package is frozen and no longer receives updates. This makes the GitHub Releases desktop build the primary, recommended install path and demotes npm to a still-works-but-not-recommended fallback.

Changes

  • README.md — lead the Install section with the desktop download table + ao start; move the npm block into a collapsed <details> noting the package is frozen.
  • installation.mdx — lead "Install AO" with the releases download table and a warn Callout that npm is no longer recommended; keep the npm/pnpm/yarn/from-source tabs below for anyone who still wants the CLI.
  • Fix the from-source clone URL: ComposioHQ/agent-orchestratorAgentWrapper/agent-orchestrator.

Notes

Three pre-existing doc issues were left out of this PR (separate from the npm-vs-releases change) and can be addressed follow-up:

  • ao doctor --fix is documented but no --fix flag exists in the CLI (doctor.go only has --json).
  • ao dashboard --rebuild is documented but there is no dashboard command.
  • The from-source pnpm build steps are still incorrect for this Go + npm repo.

🤖 Generated with Claude Code

The @aoagents/ao npm package is frozen and no longer updated. Lead the
README and installation guide with the desktop build download; keep npm
as a still-works-but-not-recommended fallback. Also fix the from-source
clone URL (ComposioHQ -> AgentWrapper).

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

@harshitsinghbhandari harshitsinghbhandari left a comment

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Requesting changes. The direction (releases as primary, npm demoted) is right, but the newly primary instructions do not work end-to-end for a fresh user:

  1. The macOS row links a .dmg that does not exist. releases/latest (v0.10.2) ships macOS as zips only (agent-orchestrator-darwin-arm64.zip etc.); the dmg maker is still a follow-up (see the .github/workflows/desktop-testing.yml header). The label was pre-existing in the README, but this PR promotes the table to the primary install path and copies it into new docs content, so it should point at real assets, ideally the constant releases/latest/download/<stable-name> URLs that ao start itself uses (backend/internal/cli/start.go).
  2. "After installing, run ao start" assumes ao is on PATH, but the desktop build does not install a CLI (no shim/symlink logic anywhere in frontend/src; the CLI ships via the npm package this PR demotes). A desktop-only user just opens the app, which owns the daemon. It is also inverted relative to docs/ao-start-bootstrapper-and-npm-deprecation.md, where ao start is the npm-side bridge that fetches and opens the app.
  3. installation.mdx is now internally inconsistent: the intro info callout (lines 13-16, "The published package is @aoagents/ao. It provides the global ao command...") still frames npm as what AO installs, and the whole verify/start flow below (ao --version, ao start, ao doctor) only works on the npm path. If desktop is the recommended path, the page needs a desktop-flavored "open the app" step, or the recommendation should match the bootstrapper design (install CLI, run ao start, it fetches the app).

Non-blocking follow-up: the landing page still pushes npm as the primary CTA (LandingHero.tsx npx @aoagents/ao start, LandingCTA.tsx, LandingQuickStart.tsx npm i -g @aoagents/ao), which now tells visitors to install a frozen package.

Comment thread frontend/src/landing/content/docs/installation.mdx Outdated
Comment thread README.md Outdated
Comment thread frontend/src/landing/content/docs/installation.mdx Outdated
Address review on AgentWrapper#2495:
- Link real stable release assets (darwin zip, win32 exe, linux AppImage)
  via releases/latest/download, matching what `ao start` fetches. No .dmg
  asset exists yet.
- Desktop build installs no CLI, so the primary flow is 'open the app'
  (the app owns the daemon), not 'run ao start'. ao start stays documented
  as the legacy npm-side bridge that fetches and opens the app.
- Make installation.mdx internally consistent: reframe the intro callout,
  gate 'ao --version' behind the CLI path, and give the start step a
  desktop-app branch.

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

Copy link
Copy Markdown
Collaborator Author

Addressed in 904e933:

  1. Real asset links. Tables in both README.md and installation.mdx now point at the stable releases/latest/download/<name> URLs that ao start itself fetches (assetName()/downloadURL() in backend/internal/cli/start.go): agent-orchestrator-darwin-arm64.zip, agent-orchestrator-darwin-x64.zip, agent-orchestrator-win32-x64.exe, agent-orchestrator-linux-x64.AppImage. Dropped the non-existent .dmg and the literal Setup.exe.
  2. PATH assumption. Primary flow is now "open the app" (the desktop build owns the daemon and installs no CLI). ao start is documented only as the legacy npm-side bridge that fetches + opens the app, per docs/ao-start-bootstrapper-and-npm-deprecation.md.
  3. installation.mdx consistency. Reworked the intro line + "What AO installs" callout to be desktop-first with npm as the legacy on-ramp; gated ao --version behind the CLI path (desktop users skip); and split the "Start AO in a repo" step into a desktop branch (open the app) and a CLI branch (ao start).

Non-blocking landing CTAs (LandingHero.tsx/LandingCTA.tsx/LandingQuickStart.tsx still pushing npm i -g / npx @aoagents/ao) left as a follow-up, out of scope for this docs PR.

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

Copy link
Copy Markdown
Collaborator Author

@copilot resolve the merge conflicts on this branch.

@illegalcall illegalcall merged commit 330c038 into AgentWrapper:main Jul 9, 2026
4 checks passed
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