Files
paseo/public-docs/hub/concepts.md
T
Mohamed BoudraandGitHub dfd18a44a7 Document Hub and let docs pages nest (#2864)
* feat(website): nest docs pages under landable groups

The docs sidebar could already render groups from subdirectories in
public-docs, but nothing used it because every doc was a flat file, and
two things stopped it being usable.

A group had no page of its own, so its label was only a toggle and its
name came from the directory name via formatLabel. A directory's
index.md now supplies the group's label, order, and href, which makes
the group landable and lets the label be authored rather than derived.

Categories and top-level directories named the same thing, so a
categorised doc at hub/index.md produced a group nested inside its own
category. Only directories below the top level become groups now.

Also fixes two behaviours in the sidebar:

- The open/closed effect assigned containsActive on every change, so a
  group you expanded to browse collapsed the moment you navigated
  anywhere else. Navigating in now opens a group and navigating away
  leaves it alone.
- The sidebar scrolls independently of the page and never scrolled the
  active entry into view, so loading or refreshing a page far down the
  list left the sidebar parked at the top with no visible position.

The group row is a single target: it navigates and expands, and
collapses when clicked again from the page it points at. A separate
chevron button would put two actions a few pixels apart.

* docs(hub): document Hub

Adds a Hub section covering what it is, how it works, daemons,
triggers, configuration, activity, and the two ways to run it.

The section separates using Hub from running it. Overview, quickstart,
daemons, triggers, and configuration hold regardless of who operates
the deployment; the self-hosting branch owns deploying the service and
creating the GitHub, Slack, and Discord apps it talks to. That split
falls on a real seam, because those apps are exactly what a hosted Hub
would own on your behalf. Hosted is a placeholder until it ships.

Each provider gets a trigger page carrying its events, filter
semantics, and the full paseo.event.* reference for the data a prompt
can read. That data is the thing a config author actually needs and
the thing they cannot get from anywhere else.

Every YAML block was parsed against the Hub config schema rather than
eyeballed, which kept several plausible-looking things out of the
docs: worktree prNumber takes a literal number and not a merge
variable, only daemon environments run today, and github.push has no
actor so it can never satisfy the required from_users filter.

Troubleshooting moves to order 90 so it stays last.

* refactor(website): let the active docs entry scroll itself into view

The layout queried the sidebar for the active entry after every
navigation, which coupled it to when that entry mounts. A link inside a
collapsed group only mounts once the group's own effect opens it, so
the query could run against a DOM that does not contain it yet.

Moving the scroll to the entry removes the ordering question rather
than answering it, and drops the ref and the cross-component query.

Reported by Greptile on #2864. The failure it described does not
reproduce: navigating from a page outside a collapsed group into one of
its children still scrolls correctly, verified with the group confirmed
collapsed and the sidebar forced to the top. The coupling was real even
though the bug was not.

* docs(hub): stop listing BETTER_AUTH_URL as required

It falls back to PASEO_CLOUD_PUBLIC_URL, so a deployment that sets the
public origin already has a correct auth base URL. Listing it as
required made the Fly recipe look incomplete when it was not.

Moved to optional with its default, and recorded what actually breaks
without BETTER_AUTH_SECRET: the auth routes close and nobody can sign
in.

Reported by Codex on #2864, which read the same inconsistency the other
way round and proposed adding the variable to the Fly example.

* docs(hub): attach a database in the Fly recipe

The Fly section showed inline config and a secrets command, neither of
which supplied DATABASE_URL. It defaults to localhost:5432, which on
Fly reaches nothing, so the documented deployment could not start.

fly postgres attach sets DATABASE_URL as a secret, so the step is the
attach itself rather than another variable to copy.

Reported by Codex on #2864.

* docs: align Hub self-hosting contract
2026-08-05 03:58:27 +08:00

4.2 KiB

title, description, nav, order, category
title description nav order category
How Hub works The Hub object model, how an inbound event reaches a project, and what happens when a configuration is activated. How it works 62 Hub

How Hub works

The object model

organization
├── members
├── connections    GitHub installations, Slack workspaces, Discord guilds
├── daemons        registered machines that run agents
└── projects
    └── configuration
        ├── environments
        └── triggers

Connections belong to the organization. One organization can hold several GitHub installations, several Slack workspaces, and several Discord guilds at the same time. Your personal GitHub account and two company organizations can sit side by side.

Every connection gets a slug, generated from the account it points at: getpaseo-github, boudra-github, acme-slack. Slugs are unique inside the organization, and configuration uses them to name a specific connection.

Daemons belong to the organization too. Register a machine once and any project can use it.

A project is one set of environments and triggers. Projects are how you separate work that should stay separate: one product, one team, one repository. They share the organization's connections and daemons, so separating costs you nothing.

A project has one active configuration. You edit it in the dashboard or sync it from a repository, and it applies as a whole.

Nothing is attached to a project in the dashboard. No screen assigns a repository or a channel. The project's configuration decides what it listens to, through trigger filters.

Routing

event arrives
  → the connection verifies it (signature, or an authenticated gateway)
  → the event carries a resource id (repository, workspace, guild)
  → Hub finds compiled routes referencing that resource
  → the trigger's filters run
  → the trigger's environment executes

Routes are compiled when a configuration is activated, not evaluated per event. A repository is not owned by one project, so if two projects both name it, both run.

Activation

Activating a configuration resolves what you wrote into stable identities:

You write Hub resolves it to
filters.repo: owner/repo a GitHub repository id and a connection
filters.workspace: T0123… a Slack workspace and a connection
filters.guild: 9876… a Discord guild and a connection
environment.daemon: my-box a registered daemon id

If any of those cannot be resolved through a connection in the organization, activation fails and the previous revision stays active. You find out when you push, rather than when someone comments on an issue.

A trigger with no resource filter routes to every connection of that provider in the organization. Add filters.connection: <slug> to narrow it to one.

Executions

A matched trigger produces an execution. Hub sends the create request to the daemon, then owns that agent's lifecycle: reconnect recovery, output observation, and completion.

  • timeout is absolute and defaults to 1h.
  • idle_timeout starts only when the daemon reports the agent idle, resets on the next idle report, and clears when the agent reports running. It defaults to 5m.
  • Every dispatched agent gets a per-execution MCP server with finish_execution. Completion is authoritative when the agent calls it.
  • allow_outputs adds a single-use reply tool for Slack and Discord executions.

If Hub loses the create response, or the daemon reconnects, Hub resends the same create intent with the same execution id. The daemon returns the existing agent instead of running the prompt twice.

Trust boundary

A project's configuration can reference any connection in its organization. Anyone who can push to the configuration repository controls that project's access to those connections, so protect that branch the way you protect a release branch.

Triggers require a from_users allowlist for the same reason. Without one, any stranger commenting on a public issue could start an agent on your machine.