Set up a new product docs site

Fill in the basics and submit. We'll create the folder structure under products/<slug>/, commit it to GitHub, and serve the new product at docs.offshorly.com/<slug>. First load lands ~2 minutes after submit (Render redeploys automatically on push).

Identity

Display name and slug. The slug is also the URL path.

Display name

Human-readable. Shown in the sidebar header and on the landing page.

Slug

Folder name AND URL path. Lowercase kebab-case. Auto-derived from the display name. Served at docs.offshorly.com/<slug>.

Description (optional)

One line. Shown on the landing page and as a meta description.

Target app & screenshot auth

Where the documented app lives and how the Playwright runner signs in to capture screenshots.

Target URL

Base URL of the app being documented. Playwright navigates here for every capture.

Auth strategy

Form (email + password)

Most common. The runner fills in an email + password form. Credentials live in env vars on the Render service.

Cookie injection

For SSO-only apps. Paste a session cookie value from your browser; the runner injects it before navigating.

Interactive (manual login)

Opens a browser window for manual login. Storage state cached locally. Won't work on the Render deployment — local-only.

How the runner signs in. Form is the most common; cookie is for SSO-only apps; interactive opens a browser for manual login on each run.

Screenshot login (encrypted in repo)

The bot user's email on the target app.

Password

Encrypted with AES-256-GCM using the deployment's vault key, then committed to the repo. Never appears in plaintext anywhere outside this form.

Form selectors (advanced)

Path to the login page, e.g. /login or /sign-in

Email field selector

CSS selector. Defaults work for most forms.

Password field selector

Submit button selector

Success marker (optional)

CSS selector that only appears after a successful login. e.g. [data-test=user-menu]. If omitted, the runner waits for the URL to change away from the login page.

GitHub auto-commit

Where edits get committed. Defaults to this monorepo; only override if this product should write elsewhere.

Repository (optional override)

Defaults to alexcatlin/offshorly_docs. Override only if this product's docs should live in a different repo (e.g. alongside a client's app).

Branch (optional override)

Defaults to main. Set to a different branch if you want a review PR step.

Theme overrides (optional)

By default the product uses the global Offshorly theme. Override the primary colour if this product should look different.

Primary colour (optional)

Hex value, e.g. #0066FF. Skip to use Offshorly purple.

Submitting creates the product folder, commits to GitHub, and redirects you to the env-var setup instructions.