mirror of https://github.com/getpaseo/paseo.git synced 2026-10-14 13:22:37 +00:00

Files

T

Mohamed Boudra 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

3.7 KiB

Raw Blame History

title, description, nav, order, category

title	description	nav	order	category
GitHub for Hub	Create the GitHub App your Hub uses, install it, and connect it to an organization.	GitHub App	74	Hub

GitHub for Hub

Hub talks to GitHub through a GitHub App you own. One App serves your whole Hub; each account or organization that installs it becomes a connection.

Create the App

Go to Settings → Developer settings → GitHub Apps → New GitHub App on the account that should own it.

Replace hub.example.com with your PASEO_HUB_APP_URL.

Setting	Value
Homepage URL	`https://hub.example.com`
Callback URL	`https://hub.example.com/api/integrations/github/callback`
Setup URL	`https://hub.example.com/api/integrations/github/setup`
Redirect on update	on
Webhook URL	`https://hub.example.com/webhook`
Webhook secret	a value you generate

Repository permissions:

Permission	Access	Why
Contents	Read & write	Read `.paseo/hub.yml`, let agents push
Issues	Read & write	Read comments, add reactions
Pull requests	Read & write	Read review comments, let agents open PRs
Metadata	Read	Required by GitHub

Subscribe to events:

Issue comment
Issues
Pull request review
Pull request review comment
Push

Push is what makes configuration sync work. Without it, Hub never learns that .paseo/hub.yml changed.

Configure Hub

From the App's settings page, collect:

Value	Environment variable
App ID	`GITHUB_APP_ID`
The slug in the App's URL	`GITHUB_APP_SLUG`
Client ID	`GITHUB_APP_CLIENT_ID`
A generated client secret	`GITHUB_APP_CLIENT_SECRET`
A generated private key	`GITHUB_APP_PRIVATE_KEY`
The webhook secret	`GITHUB_WEBHOOK_SECRET`

The private key downloads as a PEM file. Pass its contents in GITHUB_APP_PRIVATE_KEY, or its path in GITHUB_APP_PRIVATE_KEY_PATH.

Restart Hub. GitHub should now show as Ready in Connections.

Connect

Open Connections → GitHub → Connect. Hub sends you to GitHub to install the App, then binds the installation to your organization.

Start from Hub, not from GitHub's own install button. GitHub only calls the setup URL when an installation is created or changed, so installing directly can leave you on a settings page with nothing bound.

The connection appears with a slug derived from the account: an installation on getpaseo becomes getpaseo-github. That slug is how configuration names this connection.

Connect as many installations as you need. A personal account and several organizations can coexist in one Hub organization.

What the connection gives you

Events. Comments, issues, and reviews from every repository the installation can see. See GitHub triggers.
Configuration sync. Any repository in the installation can hold .paseo/hub.yml. See Configuration.
Tokens. Scoped, per-execution GitHub credentials.

Which repositories the installation covers is a GitHub setting. Change it on GitHub, not in Paseo.

3.7 KiB Raw Blame History