Ellie Help
Ellie Help Home What's new Getting started9 Work with Ellie4 Write and organise content7 Keep your docs up to date1 Publish and brand3 Walkthrough videos2 Changelog2 Measure and improve1 API reference1
Workspace and billing6
Connect AI tools1 Security and data3 Troubleshooting1
Powered by Ellie Docs
Workspace and billing/Project settings reference

Project settings reference

Updated 30 Oct 2026

On this page

Use Project → Settings to review and change project-level settings. This reference covers the tabs and controls that are visible there: Product, Repositories, Automation, Advanced and Danger zone, plus where to find help centre branding and domain settings.

Looking for your logo, colours, navigation or custom domain? Those live under Content → Appearance.

Product

Open Project → Settings → Product.

The Product tab of Project settings, starting with the Product profile and Sources cards

Product profile

Use Product profile to tell Ellie what your product is. A drafted by Ellie chip shows until you edit it. Click the pencil to edit Product description, Company description, the type (b2b, b2c, b2b2c, internal-tool or unknown) and Guidance for Ellie (optional) for brand voice, terminology and things to avoid, then click Save (or Cancel). If the card is empty, click Add manually.

Sources

Marketing website has a Read website button, and Existing help centre URL has an Import as drafts button. Enter a public http(s) URL (https:// is added if missing; empty clears the field), then click the button; saving a URL does not scrape by itself. Imported articles arrive as drafts and progress shows on the Overview checklist. An invalid URL shows 'must be a valid, publicly reachable http(s) URL', and a running job shows 'Already running'.

Doc spaces

Each space shows its name, an audience chip (external, internal or developer) and a tone dropdown: professional, friendly, marketing or technical.

Enable internal docs creates an Internal Docs space for support and ops runbooks that customers never see.

Enable developer docs creates an API Reference space published at /api on your help centre. Leave the optional OpenAPI field blank to use the spec Ellie already found. Internal and developer docs both need the Growth or Scale plan; on Free and Starter the button is disabled with a plan chip.

Roles

Roles lists the roles Ellie found in your code, where each is used and why Ellie classed it.

Choose Your team only (screens and controls behind it never appear in customer docs), Customers (documented normally) or Not a login role. A set by you chip marks your answers, which win over Ellie's.

Role changes apply to new drafts, reviews and suggestions straight away. Check customer docs appears when a role is Your team only; it scans customer articles and files suggestions, and never edits articles directly.

Repositories

Open Project → Settings → Repositories.

Each repository (owner/repo) shows a primary chip, a role such as Web app, Backend API or Shared library, its stack, a summary and 'synced <date>'. The primary repo is the user-facing app that screenshots come from.

To add a repository, type owner/repo and click Add repo, then run Re-analyse repo to pick up its features.

To remove a repository, click the trash icon and confirm. Its auto-detected features are removed too, but features you wrote or edited stay. The primary repo cannot be removed.

Automation

Open Project → Settings → Automation.

The Automation tab with its Doc maintenance, Pre-release features and Sample data cards

Doc maintenance

Doc maintenance decides how Ellie's edits apply after a code change. Approve first (the default) makes every change wait as a suggestion.

Confidence-based applies high-confidence edits automatically, as tracked and revertible revisions, and leaves uncertain ones as suggestions. Set Auto-apply at >= from 0 to 1 in steps of 0.05 (default 0.8).

Fully automatic applies all edits at once. New articles and removals always wait for your approval, and locked articles and your own uploads only ever get suggestions.

Pre-release features

Use Pre-release features to control how pre-release updates are handled.

  1. Open the mode selector.
  2. Choose one of these options:
    • Hold as drafts
    • Publish with a label
  3. If you chose Publish with a label, enter a value in Label text.
  4. Save your change.

Label text is limited to 24 characters.

A plan gate applies to Publish with a label. If your plan does not include this feature, that option is unavailable unless it is already selected for the project.

Sample data

Use Sample data to save guidance Ellie can use for example data.

  1. In Sample data, click the Edit button.
  2. Enter text in Guidance for example data (optional).
  3. Click Save.

If you do not want to keep your edits, click Cancel.

If a save is already in progress, the button changes to Saving….

If the project has a previous seed result, the card shows Last seed run: {date}.

Simulated integrations

Use Simulated integrations to turn simulated integrations on or off for the project.

  1. In Simulated integrations, use the toggle to switch the setting.
  2. Check the status text beside it:
    • On
    • Off

The card can also show provider chips with usage labels such as GitHub App, sign-in, and API.

For instance projects, this toggle is disabled.

Advanced

Open Project → Settings → Advanced.

Environment variables

The Environment variables card sets variables Ellie passes to the test copy of your app when it takes screenshots and records walkthrough videos. Use them to switch on features that are hidden behind a setting, or to give the test copy configuration it needs to start. Ellie may add its own entries here for the sandbox test login; leave these alone. They never reach your live app, and changes apply from the next screenshot run or video.

Each row has a name and a value. Click Add variable to add a row, edit a row to change it, click the bin icon to remove it, then click Save (or Discard to undo unsaved edits; Discard only appears when you have unsaved changes).

After you save, values that look like secrets (for example names containing PASSWORD, SECRET, TOKEN or KEY) are hidden: the value field shows Hidden. Leave blank to keep it. Leave it blank to keep the stored value or type a new one to replace it.

If no repository is connected yet, a notice says there is no test copy to pass these to, and the variables take effect once you connect GitHub.

For step-by-step instructions, limits and error messages, see Set environment variables for your test copy.

Danger zone

Open Project → Settings → Danger zone.

The Danger zone tab includes a card titled Delete this project.

The Delete this project card says it removes the project and everything generated for it: articles, screenshots, revisions and onboarding history. This cannot be undone. Click Delete project, type the exact project name (case-sensitive) in the Delete <project name>? dialog, then click Delete forever, which stays disabled until the name matches. Cancel closes the dialog.

Deleting a project is irreversible.

Good to know

Recent updates

All updates →
On this page