Skip to content

Update page structure of server quickstart, additional small edits#33

Draft
feorlen wants to merge 1 commit intoagentcontrol:mainfrom
feorlen:feorlen-quickstart-updates
Draft

Update page structure of server quickstart, additional small edits#33
feorlen wants to merge 1 commit intoagentcontrol:mainfrom
feorlen:feorlen-quickstart-updates

Conversation

@feorlen
Copy link

@feorlen feorlen commented Mar 20, 2026

Several changes to clarify and improve the Quickstart and UI Quickstart pages.

quickstart.mdx:

  • Restructure sections for better flow for the two installation paths. The existing headings (as shown in the page table of contents) did not clearly differentiate between the two possible methods.
  • Update text where needed to match the new heading structure.
  • Add a note that this tutorial was tested on macOS. TODO: add specific version detail.
  • Add uv to the list of prerequisites.

ui-quickstart.mdx:

  • Update the "viewing the dashboard" link to match the text of the target heading. The text in the link and the name of the section it took you to were different and confusing.

built-in-evaluators.mdx:

  • Correct a typo in the list evaluator description and example.

Shortcut ticket

For Galileo internally raised PRs only, please update this with your shortcut ticket.

SC-number

Keep the formatting, replacing SC-number with the shortcut ticket, e.g. [SC-12345], and adding the link to the ticket correctly in the brackets. This format is important as it allows Shortcut to track the ticket, moving the status to in review, then merged once the ticket is merged.

For external PRs, please add the issue (just put the number after the # below, and GitHub will automatically create a link):

No linked issue.

Checklist before requesting a review

  • - Is this ready for review? If not, raise as a draft PR
  • - This deployed to a staging environment correctly
  • - I have reviewed my changes
  • - I have reviewed the deployed version of my changes
  • - I have tested any code that is added or updated
  • - I have verified all images and videos are clear, with appropriate zoom
  • - I have verified all images and videos match production (or dev for unreleased features)
  • - I have tested that the content matches the functionality in production (or dev for unreleased features)
  • - All checks have passed
  • - This references a feature that is public. If not, add a note and we can schedule the merge for after the feature release

@feorlen feorlen marked this pull request as draft March 20, 2026 23:08
"logic": "any",
"match_mode": "contains",
"case_sensitive": false
"case_sensitive": False
Copy link
Author

Choose a reason for hiding this comment

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

This example did not work for me because false was undefined. Both "false" and False worked, changed this to False to make it more obvious it is a bool.


- **Node.js 18+** — for the local development web dashboard (optional)

This tutorial was tested on macOS.
Copy link
Author

Choose a reason for hiding this comment

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

I know this was tested on macOS, but not which versions. It would be good to add version detail if available.

Just sticking this line here isn't my favorite, but it's a clue if someone runs into trouble on their system. Thorough testing of OS requirements is beyond the scope of this PR.

For me, it worked on Ubuntu 24.04 but not 22.04.

> 💡 **Verify the server:** Open [http://localhost:8000/health](http://localhost:8000/health) — you should see `{"status": "healthy", "version": "..."}`.

## Step 2: Install the SDK
#### Install the SDK
Copy link
Author

Choose a reason for hiding this comment

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

H4s are less than ideal but work. Perhaps revisit with a larger overhaul in the future.

## Prerequisites

Before starting the UI, make sure the **Agent Control server** is already running. If you haven't set it up yet, follow the [Quickstart](/core/quickstart) first.
Before starting the UI, make sure the **Agent Control server** is already running. If you haven't set it up yet, follow the [Quickstart](/core/quickstart) first. This tutorial was tested on macOS.
Copy link
Author

Choose a reason for hiding this comment

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

- **pnpm 9+** — install from [pnpm.io](https://pnpm.io/) or run `corepack enable && corepack prepare pnpm@latest --activate`

> **Note:** If you started the server using **One-line setup** from the [Quickstart](/core/quickstart), the UI is already running at [http://localhost:4000](http://localhost:4000). You can skip the setup steps below and jump directly to [viewing the dashboard](#create-controls-from-the-ui).
> **Note:** If you started the server using **One-line setup** from the [Quickstart](/core/quickstart), the UI is already running at [http://localhost:4000](http://localhost:4000). You can skip the setup steps below and jump directly to [Create Controls from the UI](#create-controls-from-the-ui) to add a control.
Copy link
Author

Choose a reason for hiding this comment

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

The original text for this link was not clear where it was sending you. Updated to match the target header.

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