Skip to content

Add a Download & Install page to Getting Started#442

Open
jetm wants to merge 2 commits into
mainfrom
jtia/field-notes-followup
Open

Add a Download & Install page to Getting Started#442
jetm wants to merge 2 commits into
mainfrom
jtia/field-notes-followup

Conversation

@jetm

@jetm jetm commented Jul 6, 2026

Copy link
Copy Markdown
Contributor

Problem

The docs covered installing the Avocado CLI but never the Avocado Desktop app, and no single page pointed a new user at both.

Solution

Add a "Download & Install" page under Getting Started that covers both products.

Key changes

  • Add getting-started/download documenting the macOS desktop DMG, the Homebrew cask, the macOS 13.0+ requirement, and the Windows/Linux "coming soon" state.
  • Present the CLI curl one-liner and link to the existing CLI installation guide for the full platform matrix instead of duplicating it.
  • Wire the new page into the Getting Started sidebar.

Reviewer notes

  • npm run build passes: the new page renders at /developer-reference/getting-started/download, appears in the Getting Started sidebar, and its cross-link to the CLI installation guide resolves (Docusaurus fails the build on broken links).
  • The install commands (curl -fsSL https://connect.peridio.com/install.sh | sh and brew install --cask avocado-desktop) are documented, not executed in this change.
  • The desktop DMG link points at the current 0.4.4 release; it will need bumping on future desktop releases until the release manifest is served with CORS enabled (tracked separately).

Copilot AI review requested due to automatic review settings July 6, 2026 19:56

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Adds a single “Download & Install” entry point under Getting Started (covering both Avocado Desktop and the CLI) and publishes the previously-drafted Node.js dashboard portability field note, alongside a couple of small doc/UI polish fixes.

Changes:

  • Add a new Getting Started “Download & Install” doc covering macOS Desktop (DMG + Homebrew cask) and the CLI one-liner, with a link to the full CLI install guide.
  • Wire the new doc into the Guides sidebar.
  • Publish the Node.js dashboard portability field note (remove draft gating) and apply minor copy/link cleanup in related docs/components.

Reviewed changes

Copilot reviewed 5 out of 6 changed files in this pull request and generated no comments.

Show a summary per file
File Description
src/src/components/TestStatus/index.jsx Adjusts the reference link to use href for external URLs.
src/sidebars-guides.js Adds the new Getting Started page to the Guides sidebar.
src/field-notes/2026-07-01-nodejs-dashboard-portability.mdx Publishes the portability field note by removing draft: true / placeholder text.
src/field-notes/2026-06-22-fastest-path-ai-vision-nvidia.mdx Minor TL;DR copy edit (typo/wording cleanup).
src/docusaurus.config.js Minor blog description whitespace cleanup.
src/docs-guides/getting-started/download.md New “Download & Install” page documenting Desktop + CLI install paths.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

The docs covered installing the Avocado CLI but never the Avocado
Desktop app, and no single page pointed a new user at both.

Add a Download & Install page under Getting Started covering the macOS
desktop DMG, the Homebrew cask, the minimum macOS version, and the
Windows/Linux "coming soon" state, alongside the CLI curl one-liner. It
links to the existing CLI installation guide for the full platform
matrix rather than duplicating it, and wires the page into the Getting
Started sidebar.
@jetm jetm force-pushed the jtia/field-notes-followup branch from 6650250 to b1a39d5 Compare July 6, 2026 20:05
@jetm jetm changed the title Add Download & Install page and publish portability note Add a Download & Install page to Getting Started Jul 6, 2026
The bare `avocado-desktop` cask name does not resolve without the tap
already added. Use the fully-qualified `avocado-linux/tap/avocado-desktop`
so the documented command works in one step.
Copilot AI review requested due to automatic review settings July 6, 2026 20:36

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

Comment on lines +22 to +25
Download the latest release directly:

- [Download Avocado Desktop for macOS](https://repo.avocadolinux.org/releases/desktop/stable/Avocado-0.4.4.dmg)

Comment on lines +28 to +30
```bash
brew install --cask avocado-linux/tap/avocado-desktop
```
@jetm jetm requested a review from lee-reinhardt July 6, 2026 21:40
@jetm

jetm commented Jul 6, 2026

Copy link
Copy Markdown
Contributor Author

@lee-reinhardt mind giving this a review? It's the docs half of the Download page: a Getting Started "Download & Install" page covering the macOS DMG, the tapped Homebrew cask, and the CLI curl one-liner. Pinned to 0.4.4 for now per our Slack thread; I'll bump to 1.0 once that's the stable build. This is the docs side Bill was asking about.

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