Connecting a project

A project needs a name and one content source. Pick whichever fits — a project isn’t locked into one or the other.

Option 1: GitHub

Create the GitHub App (once per instance)

Org admin only, and only needed once: Settings → GitHub → Create GitHub App. This is a one-click manifest flow — GitHub hands the credentials straight back, no manual form-filling.

Connect a repo

On the project page, Connect repository installs the App on one repo and picks it.

Push to publish

A push to the project’s configured branch triggers a rebuild automatically via webhook.

Note

The GitHub App is installed per-repo, not org-wide — a project’s access is exactly the one repo it needs.

Option 2: Upload a docs.zip

No GitHub connection at all. Anyone with editor access on the project can use it:

Zip your docs folder

Whatever you’d git clone and find docs.json inside — zip it directly, or zip its parent folder (both work; the wrapping folder is detected and flattened automatically).

Upload

On the project page, Upload docs → Upload & build. 20MB limit.

Re-upload to update

There’s no “watch” on an uploaded zip — publishing a change means uploading again.

Who can do what

Roles are per-project, independent of org-admin status:

Role	Can
Owner	Everything below, plus connect/reconnect the repo, add or remove project members
Editor	Trigger rebuilds, upload docs, edit branch/docs path settings
Viewer	View build history and the live site

Org admins can do all of the above on every project, regardless of whether they’re listed as a project member.

Note

A project owner can rename a project from its Source & settings tab. Renaming changes the project’s slug, which changes its docs URL — the built site moves with it, but any existing links to the old URL stop working.

Visibility and broken links

Also on Source & settings, two per-project toggles (take effect on the next build):

Don't index this projecttoggle

Adds noindex, nofollow to every page and serves a disallow-all robots.txt, while keeping the site itself publicly reachable — for a project you don’t want search engines picking up.

Fail builds on broken linkstoggle

Every build already checks internal links against known pages and logs warnings for anything broken (this behind-the-scenes check is the same one huellup validate runs). With this on, a broken link fails the build instead of just warning. A link to localhost or any local address fails the build either way, regardless of this setting — that kind of link can never resolve for a real reader.