@gentbajko/slopify 2.5.0 → 3.0.1

package/dist/tutorials/Docker.md

@@ -0,0 +1,171 @@
+# Docker
+
+On Linux you can have Slopify run in Docker in the background, restarting whenever Docker does. One command installs it, one command updates it, and your project files stay in a normal folder on your computer.
+
+**Where to find it:** a terminal, `npx @gentbajko/slopify@latest --docker`. Inside the app, Settings → **Backup & storage** → **Your files** and Settings → **General** show the Docker-specific parts.
+
+## What you need
+
+- Linux with Docker Engine and the Docker Compose plugin.
+- Node 26 or newer on the host, to run the installer.
+- Your normal user account, with access to Docker. Don't run the installer with `sudo`. If Docker says permission denied, add yourself to the `docker` group (`sudo usermod -aG docker $USER`), then log out and back in.
+
+Refused setups: Docker Desktop, a remote Docker daemon, and rootful Docker with `userns-remap`. Rootless Docker works; the container then runs as user `0:0`, which is you on the host.
+
+On Windows, macOS or anything else, run Slopify without Docker ([Install](Install)), or run the compose file yourself ([below](#run-the-compose-file-yourself)).
+
+## Install Slopify in Docker
+
+1. Open a terminal as your normal user.
+2. Run `npx @gentbajko/slopify@latest --docker`.
+3. If Claude Code, Codex or Gemini CLI is installed on this computer, the installer asks once whether Slopify may use them (see [The host CLI bridge](#the-host-cli-bridge)). Answer `y` to allow it, or anything else to stop without changing anything. To use API keys only, run the command with `--host-cli=off` instead.
+4. It asks `Start Slopify when you log in? (Y/n)` once. See [Start at Login](Start-at-Login#docker).
+5. When it finishes it prints:
+   - `Slopify 3.0.0 is running at http://127.0.0.1:6969`
+   - `Project files on this machine:` your Projects folder
+   - `Backups on this machine:` your Backups folder, on a new install
+   - which AI tools it will use (the host CLIs, or API keys only)
+6. Open `http://127.0.0.1:6969` in your browser and continue with [First Launch and Welcome](First-Launch-and-Welcome).
+
+Running the same command again with nothing changed does nothing, apart from starting the container if it was stopped.
+
+## What gets installed
+
+| Part | What it is |
+| --- | --- |
+| Image | `ghcr.io/gentbajko/slopify:<version>`, pinned to the version of the installer you ran. It runs as a non-root user and already contains ffmpeg, the caption model and eSpeak NG, so the [System voice](Providers-and-Keys#the-system-voice) can narrate with no key. A healthcheck asks the app whether it is up. |
+| Compose file | Copied to `~/.local/share/slopify/docker/slopify/` with a private `.env` beside it. One service, `slopify`, with `restart: unless-stopped`. |
+| Port | `127.0.0.1:6969` on the host, localhost only. |
+| Data volume | `slopify-data`, mounted at `/data`. It holds the database, provider keys, settings, logs and staging. It is declared external, so `docker compose down` (even with `-v`) never deletes it. |
+| Projects folder | A folder on your computer, mounted at `/data/projects`. |
+| Backups folder | A folder on your computer for scheduled backups, mounted at `/data/backups` (new installs from 3.0). |
+| Host CLI bridge | Optional. A small helper that lets the container use your AI command-line tools. |
+| `install.json` | In the same folder as the compose file. Records the version, port, project folder, user and whether the bridge is on. |
+
+## Where your files go
+
+| Install | Projects | Backups |
+| --- | --- | --- |
+| New install (3.0 and later) | `<Documents>/Slopify/Projects` | `<Documents>/Slopify/Backups` |
+| Installed before 3.0 | `~/Slopify/Projects` (kept as it was) | `~/Slopify/Projects/Backups` |
+
+`<Documents>` is what `xdg-user-dir DOCUMENTS` answers, then `XDG_DOCUMENTS_DIR` in `~/.config/user-dirs.dirs`, then `~/Documents`.
+
+Everything else (database, keys, logs) stays private in the `slopify-data` volume. See [Where Your Files Live](Where-Your-Files-Live).
+
+## Change a setting
+
+Run the install again with the setting you want. Settings you leave out are remembered from `install.json`.
+
+| Option | What it does |
+| --- | --- |
+| `--port <number>` | Serves Slopify on another host port, still on `127.0.0.1`. |
+| `--projects-dir <folder>` | Uses another folder for project files. The files are copied and checked first; the old folder is left as it was. The new folder must be empty. A `~/` at the start is understood. |
+| `--projects-dir documents` | Moves an existing install's projects to `<Documents>/Slopify/Projects`. |
+| `--host-cli=off` | Turns the host CLI bridge off; Slopify uses API keys only. `off` is the only accepted value. |
+| `--accept-host-cli` | Approves the host CLI bridge without the question, for scripts. |
+| `--autostart` / `--no-autostart` | Answers the start-at-login question without asking. |
+
+`--host` and `--data-dir` can't be combined with `--docker`.
+
+For several Docker installs on one machine, give each its own `SLOPIFY_DOCKER_NAME` and `SLOPIFY_DOCKER_VOLUME` (letters, digits, dots, dashes and underscores). A second install's Documents folder is `<Documents>/Slopify/<name>/Projects`.
+
+## Move your projects into Documents
+
+A container can't move its own mounted folder, so the installer does it from the host.
+
+1. Open Settings → **Backup & storage**. Under **Your files** you see the command to run, with **Copy command**.
+2. On the computer running Docker, run `npx @gentbajko/slopify@latest update --docker --projects-dir documents`. For another folder, use `--projects-dir <folder>`.
+3. The installer waits for running work to finish, copies the folder, checks the copy and remounts the new folder.
+4. The old folder is left as it was. Once your projects open fine, you can delete it.
+
+Backups stay where they were (`Projects/Backups` on an older install).
+
+## Update the Docker install
+
+Run `npx @gentbajko/slopify@latest update`. With a Docker install on your user account, `update` goes to it automatically (`update --docker` is the same). The **Update** button inside the Docker app shows this command, because a container can't replace itself.
+
+The update is one transaction:
+
+1. It waits until nothing is generating. Pressing `Ctrl+C` while it waits changes nothing.
+2. It stops the container and copies the whole data volume into a recovery volume, `slopify-data-recovery-<id>`, checked file by file.
+3. It starts the new version and waits up to 2 minutes for it to answer as that version.
+4. On success it records the new version and removes the older recovery volume, so only the newest one is kept.
+5. If the new version doesn't answer, it removes it, copies your data back from the recovery volume and starts the previous version with its previous settings.
+
+If an install or update is cut off (`Ctrl+C`, a reboot), the next run first finishes putting things back, then continues.
+
+The recovery volume covers the database and settings, not your Projects folder. When you make your own backups, keep both the `slopify-data` volume and your Projects folder, or use [Backups](Backups).
+
+## The host CLI bridge
+
+If Claude Code, Codex or Gemini CLI is installed on the host, Slopify in Docker can use them with the logins you already have. Nothing about your logins is copied into Docker.
+
+- With your OK, the installer sets up a small helper, at the same version as the image, and keeps it in step on every install and update.
+- The helper runs as the systemd user service `slopify-cli-bridge.service`, as you. User lingering is turned on so it runs at boot and after you log out.
+- It talks to the container through a private socket in `~/.local/share/slopify/host-cli/share/`, with a token. There is no network port. Only that `share` folder is mounted into the container, read-only.
+- Codex images, run cost and plan-limit readings work the same as without Docker.
+- The helper only opens folders inside your Projects folder when you press **Open folder**.
+- With the bridge off, Settings shows the CLIs as unavailable, and API keys still work.
+
+Check or turn it off:
+
+```sh
+systemctl --user status slopify-cli-bridge.service
+systemctl --user disable --now slopify-cli-bridge.service
+```
+
+Turning it off leaves Docker, your API providers, your data and your host logins as they are. Run the install again after installing or moving a CLI.
+
+If the installer can't ask (no interactive terminal), it stops and tells you to rerun with `--accept-host-cli` or `--host-cli=off`. Using the bridge needs systemd user services (`systemctl --user`); without them, use `--host-cli=off`.
+
+## Coming from 2.5.0 or earlier
+
+The first run of the new installer takes your existing installation over:
+
+- It reuses the `slopify-data` volume by name; it is never deleted or recreated. A container on another volume is refused, with the `SLOPIFY_DOCKER_VOLUME` value to use.
+- It keeps the project folder the old container used (`~/Slopify/Projects`, or your `--projects-dir`). A plain `docker run` container that kept projects inside the volume gets them copied, checked, to `~/Slopify/Projects`; the copy in the volume stays.
+- The old container is stopped and renamed `slopify-previous-<id>` while the new one starts. If the new one fails, the old one is put back exactly as it was. It is removed once the new one is committed.
+- If a 2.5.0 launcher update was left unfinished, nothing is changed. Run `npx @gentbajko/slopify@2.5.0 --docker` once so it finishes or undoes it, then install again.
+
+## Run the compose file yourself
+
+Without the installer (any OS with Docker Compose), with API keys only, from a folder containing Slopify's `compose.yaml`:
+
+```sh
+docker volume create slopify-data
+mkdir -p ~/Documents/Slopify/Projects
+SLOPIFY_PROJECTS_DIR=~/Documents/Slopify/Projects SLOPIFY_USER="$(id -u):$(id -g)" \
+  docker compose -f compose.yaml up -d
+```
+
+| Variable | Default | What it does |
+| --- | --- | --- |
+| `SLOPIFY_PROJECTS_DIR` | none, required | The host folder for project files. |
+| `SLOPIFY_IMAGE` | `ghcr.io/gentbajko/slopify:latest` | The image to run. |
+| `SLOPIFY_PORT` | `6969` | The host port, bound to `127.0.0.1`. |
+| `SLOPIFY_USER` | `1000:1000` | The user id the container runs as, so project files belong to you. |
+| `SLOPIFY_VOLUME` | `slopify-data` | The data volume's name. It must exist (`docker volume create`). |
+| `SLOPIFY_BACKUPS_DIR` | empty | The host folder for scheduled backups. Without it, backups stay in `Projects/Backups`. |
+| `SLOPIFY_HOST_CLI_SHARE` | empty | The host CLI bridge's share folder, if you set one up. |
+| `SLOPIFY_NAME` | `slopify` | The compose project and container name. |
+
+Update by changing `SLOPIFY_IMAGE` and running `docker compose up -d` again. This way has no automatic recovery copy or rollback, and Settings → General can't tell whether Docker starts at login.
+
+Keep the `127.0.0.1` binding. Anyone who reaches Slopify's port controls the app and its provider keys.
+
+## Tips
+
+- Settings → **General** shows **Starts with Docker: yes / no / unknown**, read by the installer. Run the install command again after changing Docker's own start-up setting so it looks again.
+- Port 6969 taken by a native Slopify? Stop the native one, or give Docker another port with `--port 7070`.
+- To stop Slopify for a while without removing anything, run `docker stop slopify`; `docker start slopify` or the install command starts it again.
+
+## Related pages
+
+- [Install](Install)
+- [Where Your Files Live](Where-Your-Files-Live)
+- [Start at Login](Start-at-Login)
+- [Updating and Patch Notes](Updating-and-Patch-Notes)
+- [Uninstalling and Moving](Uninstalling-and-Moving)
+- [AI CLIs](AI-CLIs)
+- [Backups](Backups)

package/dist/tutorials/Document-Themes.md

@@ -0,0 +1,207 @@
+# Document Themes
+
+A document theme is the look of the PDF Slopify makes from the article: paper size, colours, fonts, spacing, the title page, contents, sources and closing pages, headers and page numbers. Slopify ships a built-in **Plain** theme. Copy it to make themes of your own, with a live preview as you edit.
+
+**Where to find it:** **Library → Documents**. Pick a theme on Play's **Document** row, in **Edit project**, or as a channel's default in its brand kit.
+
+## Built-in and your own themes
+
+| List | What it holds |
+|---|---|
+| **Built-in themes** | Looks that ship with Slopify and can't be changed. **Plain** is an unbranded flat page and what a new project gets. Press **Copy theme** to make an editable copy. |
+| **Your themes** | Themes you made or copied. Each has **Edit**, **Duplicate** and **Delete**. |
+
+A project keeps its own copy of the theme's settings. Editing or deleting a theme never changes a PDF already made or queued.
+
+## Make a theme
+
+1. Open **Library → Documents**.
+2. Press **New theme** (it starts from Plain), or pick a built-in theme and press **Copy theme**, or press **Duplicate** on one of your themes.
+3. Type a **Name** (up to 80 characters). This is what the Document row on Play and Edit project shows.
+4. Open the groups on the left and change what you like (every setting is listed below). The first two groups start open.
+5. Watch the **Preview** on the right. It lays out a sample article with this theme using the same renderer that makes a project's PDF, redrawn about half a second after you stop typing. It runs on your computer and costs nothing.
+6. Press **Save**. If a setting is out of range it is highlighted, and Save says "Fix the highlighted settings first."
+
+## Use a theme
+
+- **On Play:** open the **Document** row (the PDF output) and pick the theme. See [PDF documents](PDF-Documents).
+- **On a finished project:** open **Edit project** (the **Edit settings** button), pick the theme under **Document theme**, save, and remake the document.
+- **For a channel:** set **Document theme** in the channel's brand kit. Videos whose template picks no theme get it. See [Channels](Channels).
+
+## Delete a theme
+
+Press **Delete** on the theme and confirm. Projects that used it keep their own copy of its settings. A channel whose brand kit named it skips it.
+
+## Every setting
+
+Sizes are in millimetres (mm) unless marked pt (points; 1 pt is about 0.35 mm). Defaults are the Plain theme's.
+
+### Page
+
+| Setting | What it does | Default | Range |
+|---|---|---|---|
+| **Paper size** | A4 (210 × 297 mm) for most of the world, US Letter (216 × 279 mm) for the US and Canada. | A4 | |
+| **Margins** | Blank space on every edge of each page. Wider margins mean shorter lines and more pages. | 22 mm | 5 to 60 |
+| **Text starts at** | How far from the top the text begins on pages with the running header. Raise it when text crowds the header. | 32 mm | 5 to 80 |
+| **Background** | **Parchment texture** stretches an aged-paper picture over every page. **Flat colour** fills each page with the Page colour, slightly darker at the edges. | Flat colour | |
+| **Page colour** | The page colour with Flat colour. Type a hex code or use the picker. | `#fdfaf3` (warm off-white) | |
+
+### Colours
+
+| Setting | What it colours | Default |
+|---|---|---|
+| **Heading colour** | Headings, drop caps, the brand name and links | `#1f3a5f` (dark blue) |
+| **Body text colour** | Paragraphs, lists, bold and italic text. Keep it dark against the page. | `#1a1a1a` (near black) |
+| **Muted colour** | Dates, bullets, quotes and the dotted lines on the contents page | `#555555` (mid grey) |
+| **Faint colour** | The running header and page numbers | `#888888` (light grey) |
+
+### Fonts
+
+Each font has three controls: the family, its weight or italic, and **Letter spacing (mm)** from −0.5 to 2. The families are **Cinzel** (bundled; four weights, no italics) and **Times**, **Helvetica** and **Courier** (built into every PDF reader).
+
+| Setting | Where it is used | Default |
+|---|---|---|
+| **Body font** | Paragraphs and lists | Cinzel Regular, 0.01 mm |
+| **Bold text font** | Bold words in paragraphs | Cinzel Bold, 0.02 mm |
+| **Italic text font** | Italic words in paragraphs (Cinzel has no italics, so this borrows Times) | Times Italic, 0 mm |
+| **Heading font** | The article's headings and the contents, sources and closing page titles | Cinzel Bold, 0.02 mm |
+| **Chapter numbers and brand font** | The big number in a heading like "Chapter 3:" and the brand name on the title page | Cinzel Black, 0.03 mm |
+| **Tagline and link font** | The tagline and linked line on the title page, and the link and closing line on the closing page | Cinzel Medium, 0.015 mm |
+| **Drop cap font** | The large first letter after a heading | Cinzel Black, 0 mm |
+| **Header and page number font** | The running header and page numbers | Times Regular, 0 mm |
+
+### Text sizes
+
+| Setting | What it sizes | Default | Range |
+|---|---|---|---|
+| **Title size** | The article's title on the title page | 22 pt | 6 to 72 |
+| **Brand size** | The brand name on the title page (only shown with a brand name) | 31 pt | 6 to 72 |
+| **Top-level heading size** | Top-level headings and the contents, sources and closing page titles | 19 pt | 6 to 72 |
+| **Second-level heading size** | Headings inside a top-level section | 17 pt | 6 to 72 |
+| **Third-level heading size** | Third-level and deeper headings | 13 pt | 6 to 72 |
+| **Body size** | Paragraphs, lists and closing page text. Bigger text means more pages. | 10.5 pt | 6 to 24 |
+| **Date and word count size** | The date, word count and link lines under the title | 10 pt | 5 to 24 |
+| **Header and page number size** | The running header and page numbers | 9 pt | 5 to 24 |
+
+### Spacing
+
+| Setting | What it does | Default | Range |
+|---|---|---|---|
+| **Body line height** | Distance from one body line to the next | 8 mm | 3 to 20 |
+| **Heading line height** | Between the lines of a wrapping top- or second-level heading | 11 mm | 3 to 30 |
+| **Subheading line height** | Between the lines of a wrapping third-level heading | 9 mm | 3 to 30 |
+| **After a paragraph** | Extra space after each paragraph, as a share of a body line (0.5 is half a line) | 0.5 | 0 to 3 |
+| **Before a heading** | Extra space above each heading, as a share of a body line | 1 | 0 to 5 |
+| **After a list item** | Extra space after each bulleted or numbered item | 0.2 | 0 to 3 |
+| **List indent** | How far lists are pushed in from the left margin | 6 mm | 0 to 30 |
+| **Quote indent** | How far quotes are pushed in | 8 mm | 0 to 40 |
+| **Divider width** | The width of the short centred line a `---` in the article becomes | 30 mm | 0 to 150 |
+
+### Drop caps
+
+| Setting | What it does | Default | Range |
+|---|---|---|---|
+| **Drop caps** | Starts the first paragraph after each heading with a large letter spanning several lines, as in printed books. | On | |
+| **Drop cap lines tall** | How many body lines the letter spans | 3 lines | |
+| **Drop cap letter size** | The letter's size as a multiple of the lines it spans | 3 | 1 to 5 |
+| **Gap beside the drop cap** | Space between the letter and the text beside it | 4 mm | 0 to 20 |
+| **Shortest paragraph** | A paragraph shorter than this many characters starts plainly | 50 | 0 to 2000 |
+| **Room needed** | With less than this share of the page left, a paragraph starting with a drop cap moves to the next page (0.25 is a quarter) | 0.25 | 0 to 1 |
+
+### Title page
+
+| Setting | What it does | Default | Range |
+|---|---|---|---|
+| **Brand from top** | Where the brand name sits, from the top edge | 60 mm | 10 to 200 |
+| **Tagline below brand** | Distance from the brand name down to the tagline | 10 mm | 0 to 60 |
+| **Title from top** | Where the article's title sits, from the top edge | 80 mm | 10 to 250 |
+| **Title line height** | Between the lines of a wrapping title | 10 mm | 3 to 40 |
+| **Details below title** | Distance from the title to the date and word count, when there is no cover picture | 20 mm | 0 to 100 |
+| **Details line height** | Between the date, word count and link lines | 10 mm | 3 to 30 |
+| **Show the date** | Prints "Written on" and the date the PDF was made | On | |
+| **Show the word count** | Prints the article's word count | On | |
+| **Thumbnail as cover** | Puts the project's thumbnail between the title and the date, when there is one | On | |
+| **Space around cover** | Space above and below the cover picture | 6 mm | 0 to 40 |
+| **Cover height at most** | The tallest the cover may be; it keeps its shape and shrinks when needed | 110 mm | 20 to 200 |
+
+### Branding
+
+| Setting | What it does | Default |
+|---|---|---|
+| **Brand name** | Your channel or brand, printed large at the top of the title page and before the title in the running header ("Brand \| Title"). Empty shows no brand. | Empty |
+| **Tagline** | A short line under the brand name. Empty hides it. | Empty |
+| **Website** | The address the brand name and the title-page link open when clicked in the PDF. | Empty |
+| **Link text** | The words of a linked line under the word count on the title page; it opens Website. Empty hides the line. | Empty |
+
+### Contents page
+
+| Setting | What it does | Default | Range |
+|---|---|---|---|
+| **Contents page** | Adds a table of contents after the title page, each entry a link to its page | On | |
+| **Contents page title** | The heading of the contents page (up to 300 characters) | Table of Contents | |
+| **Lists headings down to** | Top level only, second level, or third level. Deeper lists can add a page. | Second level | |
+| **Contents title position** | From the top margin to the contents title | 20 mm | 0 to 100 |
+| **First entry position** | From the top margin to the first entry | 40 mm | 0 to 150 |
+| **Contents line height** | From one entry to the next | 8 mm | 3 to 30 |
+| **Indent per level** | How much further each deeper level is indented | 5 mm | 0 to 30 |
+
+### Header and footer
+
+| Setting | What it does | Default | Range |
+|---|---|---|---|
+| **Running header** | Prints "Brand \| Title" at the top of every page after the title page | On | |
+| **Header from top** | From the top edge to the header | 15 mm | 3 to 60 |
+| **Header title at most** | A longer title is cut short in the header to fit one line | 35 characters | 5 to 200 |
+| **Page numbers** | Prints a page number at the bottom of every page after the title page | On | |
+| **Page number text** | The words around the number; `{page}` becomes the number, so `Page {page}` prints "Page 4" | `Page {page}` | |
+| **Page number from the bottom** | From the bottom edge to the page number | 10 mm | 3 to 60 |
+| **Space kept above page number** | Space kept free above the number so body text stops short of it | 15 mm | 0 to 60 |
+
+### Sources page
+
+| Setting | What it does | Default | Range |
+|---|---|---|---|
+| **Sources page** | Adds a page listing the web links the article and its research used, each clickable | On | |
+| **Sources page title** | Its heading (up to 300 characters) | Sources Consulted | |
+| **Sources title position** | From the top margin to the title | 20 mm | 0 to 100 |
+| **Sources list position** | From the top margin to the first source | 40 mm | 0 to 150 |
+| **Sources line height** | Between the lines of one source | 8 mm | 3 to 30 |
+| **Gap between sources** | Extra space between sources | 2 mm | 0 to 20 |
+
+### Closing page
+
+| Setting | What it does | Default | Range |
+|---|---|---|---|
+| **Closing page** | Adds a last page with your own text, such as an about section or a thank-you | Off | |
+| **Closing page title** | Its heading (up to 300 characters) | About | |
+| **Closing page text** | One line per row, up to 60 lines of 300 characters. A line starting with `•` becomes a muted bullet, one ending with `:` a bold label, an empty line a gap. | Empty | |
+| **Add date, word and page counts** | Adds a Document Details list: date written, total words and total pages | On | |
+| **Closing page link** | A clickable line after your text: **Link text** and **Link address**. Without an address the words show without a link. | Off | |
+| **Closing line** | A last line, such as a sign-off, in the decorative font. Empty leaves it out. | Empty | |
+| **Closing title position** | From the top margin to the title | 20 mm | 0 to 100 |
+| **Closing text position** | From the top margin to the first line | 40 mm | 0 to 150 |
+
+### PDF details
+
+These appear in a PDF reader's document properties, not on the pages.
+
+| Setting | What it does | Default |
+|---|---|---|
+| **PDF author** | The author shown in the properties. `{title}` becomes the article title. | Empty |
+| **PDF subject** | The subject shown in the properties. | `{title}` |
+| **PDF keywords** | Search words, usually separated by commas (up to 1,000 characters) | Empty |
+| **PDF creator** | The app or person shown as the creator | Empty |
+
+## Tips
+
+- Change one group at a time and watch the preview; it redraws as you type.
+- For a book-like PDF, turn on **Parchment texture**, keep drop caps on and raise **Body line height** a little.
+- For a plain handout, set Body font to Helvetica, turn drop caps off and set **Lists headings down to** top level.
+- Put your channel name in **Brand name** and your site in **Website** so every PDF links back to you.
+
+## Related pages
+
+- [PDF documents](PDF-Documents)
+- [Channels](Channels)
+- [Library overview](Library-Overview)
+- [Play outputs](Play-Outputs)

package/dist/tutorials/Editing-a-Project.md

@@ -0,0 +1,204 @@
+# Editing a Project
+
+You can change almost anything about a project after it has run: the article, a narration chunk, one image, the prompts, the providers, the captions or the volume. Slopify saves each change as a new revision and remakes only the outputs the change affects, after you have seen what that costs.
+
+**Where to find it:** a project → **Edit settings** (top right), or **Settings** in the section rail. The form is called **Edit project**.
+
+## How editing works
+
+1. **Edit.** You change settings or content in the Edit project form. Nothing runs while you edit.
+2. **Save.** **Save changes** stores a new revision. Saving never starts work. Outputs the change affects turn **outdated** and keep their old version until they are remade.
+3. **Remake.** The next action button offers the first group of outdated outputs, for example **Remake the outdated narration** or **Remake 4 outdated images**. Press it, or open **Choose what to remake** to see the full list, the cost, and what is kept.
+
+Remaking one group can make the next group outdated in turn (new narration outdates the video); the next action then names that group.
+
+## Edit project sections
+
+The form has its own section list on the left. Some sections appear only when the project uses them.
+
+| Section | What you change there |
+| --- | --- |
+| **Inputs** | **Project title**, **Channel** and brand kit, **Stages** (the source of each stage: Research, Article, Audio, Images, Thumbnail, Video, Document), **Document theme**, **Timing** (silence, seconds per image, zoom, motion), **Cuts and look**, **Ambient sound**, **Pauses and volume**, **Intro and outro**, **Research notes**. |
+| **Article** | The **Article text** itself. Shows an "edited" badge once you have changed it. |
+| **Providers** | Language, text, narration and image providers, models, voice, speakers, Pronunciation Glossary, narration aliases, **Describe tables and figures**, chunking and Narration Preparation. |
+| **Prompts** | The **YouTube description** switch (turn it on for a project that has no description yet) and its **Description prompt**, every prompt the project uses, and the keywords. |
+| **Reviews** | Automatic reviews. See [Reviews and Checkpoints](Reviews-and-Checkpoints). |
+| **Shorts** | Shorts settings, the Shorts preview and picked clips. See [Shorts](Shorts). |
+| **Subtitles** | Caption mode, font, size, position and the style preview. See [Video Editing](Video-Editing#subtitles). |
+| **Images** | **Image prompts**, **More images for long videos**, the establishing image, thumbnail count, replacing provided files, and the image list. The badge shows how many images there are. |
+| **Narration** | The narration chunks (only when narration is generated). |
+| **Captions** | Caption text and timing. The badge shows how many captions you have loaded. |
+
+At the bottom: **Save changes** saves a revision, **Discard changes** drops the draft. While a file is uploading the bar says "Waiting for uploads to finish…" and saving waits.
+
+If someone (or another tab) saved the project while you were editing, the bar says "A newer revision is available. Your unsaved changes are kept below." Press **Reload current revision and discard my draft** to start from the newer one.
+
+## Change the article text
+
+1. Open **Edit project → Article**.
+2. Edit the **Article text** (Markdown; headings become chapters).
+3. Press **Save changes**.
+
+Your edit is kept when other settings change, and saved as a new revision. The narration, images and video made from the old text turn outdated and are remade when you choose.
+
+### Regenerate the article
+
+**Regenerate article after review** (under the article text, when the article is generated) marks the article to be written again by the text model, one or more paid text calls. Nothing runs yet: the rebuild review lists it with the narration, images and video it outdates, and you start it there. It replaces any edits you made to the article.
+
+## Edit narration
+
+**Edit project → Narration** shows the narration split into the chunks it was spoken in. Only the chunks you touch are made again, paid per character, and the video is rendered again with them.
+
+| Control | What it does |
+| --- | --- |
+| **Text for narration chunk N** | What the narrator says in this chunk. Editing it has the chunk spoken again by your voice provider when you remake outdated outputs. The other chunks keep their audio; captions and the video follow. It does not change the article. |
+| **Replace narration chunk N** | Uses your own audio file for this chunk. |
+| **Regenerate narration chunk N after review** | Speaks the chunk again with the same text and voice, for a new take when a word came out wrong. Paid per character. The current audio stays until then. **Keep narration chunk N** takes the mark off. |
+
+When the project was narrated as one whole request (Chunking set to the whole article), the form says so: editing its text rebuilds the whole narration request.
+
+## Edit images
+
+**Edit project → Images** lists every image of the video in the order it is shown. Changes apply after you save.
+
+| Control | What it does |
+| --- | --- |
+| **Prompt for image N** | The words this image is drawn from, with keywords in double braces filled in from the project. Editing it outdates only this image and the video; it is drawn again, one image call, when you remake. |
+| **Use saved wording as template for image N** | Copies the prompt as sent into the box so you can edit it. |
+| **Replace image N** | Uses your own picture in its place. |
+| **Move image N earlier** / **later** | Changes the order. |
+| **Delete image N** | Removes it. Deleting the last image also turns Images and Video off. |
+| **Regenerate image N after review** | Draws the image again from its prompt, one paid image call, with a new result. The current image stays until the new one is made. |
+| **Add generated image** | Adds a new image with an empty prompt at the end. |
+| **Add provided image** | Adds your own picture at the end. |
+| **Add a video clip** | Adds a clip (MP4, MOV, M4V, WebM or MKV). It plays muted in an image's place, trimmed, slowed (to half speed at most) or looped to fit. |
+
+A project holds at most 60 images, or 240 with **More images for long videos** on.
+
+The **Regenerate** button on an image in the project's Images section does the same thing: it opens Edit project with the change applied to the draft, and saving marks the image outdated.
+
+### Image prompts and More images for long videos
+
+- **Image prompts** is the same control as on Play: which Library image prompts the project uses and how many images each makes (its Number). The line under it says what saving will do. Raising a Number adds images right after that prompt's last one, lowering it drops its last ones, unticking a prompt drops its images, and a newly ticked prompt adds new images at the end. Images left as they were are kept and reused.
+- **More images for long videos** sets extra images by length: **Every N minutes** or **N per hour**. Saving plans the extra images and keeps every existing one.
+
+### Establishing image and provided files
+
+The establishing image can be changed or made again in the Images section. When a stage uses your own file (narration or thumbnail set to Provide), **Replace provided audio** and **Replace provided thumbnail** take a new file.
+
+## Edit captions
+
+1. Open **Edit project → Captions**.
+2. Press **Edit existing caption cues**. This works once the current narration has finished and its subtitle timing is ready.
+3. Change a caption's words, or its start and end in seconds from the start of the narration.
+4. Press **Apply caption edits to draft**.
+5. Press **Save changes**.
+
+**Apply caption edits to draft** checks every caption (text present, times in order, inside the narration) and puts your edits into the draft. Captions must not overlap and must end after they start; each problem is named, for example "Caption 4: enter caption text." Nothing is saved until **Save changes**, and the video is rendered again only when you remake outdated outputs. Caption edits cost nothing; only the subtitle files and the video are made again. The narration is not changed. **Discard caption edits** drops them.
+
+If the narration changed since you edited the captions, the form says the edits belong to an earlier narration: check them against the current one, apply and save.
+
+## Prompts
+
+**Edit project → Prompts** shows every prompt the project used (the article, Narration Preparation, YouTube description, Shorts, Shorts image style, thumbnail, establishing image, intro, outro and each image prompt).
+
+| Control | What it does |
+| --- | --- |
+| **Use saved template for ...** | Copies a prompt from your Library into this project, replacing the raw prompt. Pick it in **Choose a saved template**. |
+| **Raw prompt for ...** | This project's own copy of the prompt, with keywords still in double braces such as `{{Topic}}`. Edit it to change what the model is asked, for this project only; the Library prompt is untouched. |
+| **Saved rendered prompt** | The prompt as it was sent, with keywords filled in. |
+| **Use the Library version for ...** | Shown when the Library prompt changed since the project copied it. Copies the new wording in. |
+| **Keywords** | The keyword values, each with everything it feeds. |
+
+The project keeps its own copy of each prompt, so later Library edits reach it only when you pick it again or press **Use the Library version**. Saving fills the keywords in again, and whatever was made from the old wording turns outdated. Nothing is remade until you choose.
+
+**Write the description again after review** marks the YouTube description to be written again, one paid text call, when you save and continue or start the rebuild review. **Keep the current description** takes the mark off. See [YouTube Description](YouTube-Description).
+
+## Narration options in Providers
+
+| Control | What it does |
+| --- | --- |
+| **Also use pronunciations from my other projects** → **Update from other projects** | Copies your other projects' Pronunciation Glossary terms into this project again, picking up any added since the last copy. After you save, only the chunks whose words those terms change are spoken again, paid per character. |
+| **Use narration aliases** → **Update from Library** | Copies Library → Aliases into this project again. A Library edit reaches the project only when you press this. After you save, only the chunks the changed aliases touch are spoken again. |
+| **Describe tables and figures in the narration** | The text model writes a short spoken passage for each table, figure, equation and code block. Turning it on costs one text call per block, and after you save the chunks that contain a block are spoken again (the whole narration when Chunking is the whole article). **Leave code out** skips code blocks. |
+
+**Show tables and figures on screen** (in **Inputs → Cuts and look**, when Describe tables and figures is on) shows each described block in the video while its description is spoken, as the article's picture or a card drawn on your computer at no cost. Turning it on or off renders the video again, and any Shorts that include a card; the narration is kept.
+
+See [Narration Aliases and Glossary](Narration-Aliases-and-Glossary).
+
+## Pauses and volume
+
+**Edit project → Inputs → Pauses and volume** holds four settings. All run on your computer with no API calls.
+
+| Option | What it does | Default / range |
+| --- | --- | --- |
+| **Pause between sentences (seconds)** | The least quiet after each sentence. Adds silence where the pause is shorter; never shortens one or cuts a word. About 0.25 s is brisk, 0.35 to 0.45 natural, 0.5 to 0.8 an audiobook's pace, 0.8 and up sleep content. 0 keeps the voice's own. | 0.4; 0 to 2 in steps of 0.05 |
+| **Pause between paragraphs (seconds)** | The least quiet at the end of a paragraph, when you want more than between sentences. At 0 paragraphs get the sentence pause. Try 0.8 to 1.2 for a slower read. A speaker's turn gap is set under Speakers instead. | 0; 0 to 2 |
+| **Level the volume** | Brings every narration piece to one loudness before they are joined, then sets the video, shorts and audio files to a finished loudness. | On for new runs (Settings → General → **Level the volume for new runs**) |
+| **Video volume** | How loud the video and shorts are, in dB from the recommended level (0 dB is -14 LUFS, what YouTube and Spotify play at). -6 dB is about 50%, +4 dB about 158%. Peaks stay under -1.5 dBTP. | 0 dB; -10 to +4 dB in 0.5 dB steps |
+| **Audio files volume** | How loud the WAV, MP3 and M4B are, in dB from -18 LUFS (what audiobook shops such as ACX ask for). Peaks stay under -3 dBTP. | 0 dB; -10 to +4 dB |
+
+You can type a volume in dB or as a percentage of the recommended level.
+
+What changing them remakes:
+
+- **Pauses**: the narration is joined again from the pieces it already has and timed again, which remakes what is timed from it: captions, the video and, when on, the YouTube description and the shorts' pick (those two are text calls). No speech is made again.
+- **Level the volume on or off**: the levelled narration is joined again and the exports rendered again. No speech is made again, and word timing, description, shorts' pick and reviews are not redone.
+- **A volume only**: the exports are mastered again, nothing else.
+
+An uploaded narration is never levelled piece by piece; only the final master reaches it. Turn Level the volume off to keep the exports at your file's own level.
+
+## Choose what to remake
+
+**Choose what to remake** opens the rebuild review for every outdated or failed output. Open it from the **Settings** view, **More project actions → Choose what to remake…**, or the command palette.
+
+The review shows:
+
+- Counts of work items: **to make**, **built on this computer**, **to confirm**, **kept as they are**, and **can't run**, plus the known cost range. CLI work reads "$0 on your plan", with what the same work would cost via API.
+- **Changed inputs**: each changed input with **Before** and **After**.
+- **Work items**: every item, why it is made or kept, and **View request text** for the exact request.
+- **Cost by step**.
+
+Press **Remake N outputs** to start, or **Keep things as they are** to close it with nothing spent. When the button is off, the line beside it says why, for example that an item can't run (its reasons are listed above) or that a box needs ticking:
+
+| Tick box | When it appears |
+| --- | --- |
+| **Keep the provided content for ...** | An output uses a file or text you supplied, and something it depends on (such as the narration) has changed since. Tick to confirm it still fits. To use something else, close the review and replace the file in Edit project first. |
+| **I understand that N cost estimates are unknown.** | Some steps use a model with no published price, so their cost is left out of the total. Tick to start anyway; the real cost is recorded under Cost once they run. |
+
+The next action button and **Remake everything outdated** in the command palette start the remake at once when nothing needs ticking; otherwise they open this review.
+
+## History and saved revisions
+
+Every save of Edit project is a revision: a snapshot of the settings and content. Continuing a run always uses the current one.
+
+When the editor is closed, the **Settings** view shows **Saved revision** with each output's state: **Ready**, **Outdated; the retained version stays until it is remade**, **Provided content needs review**, or **Retained file missing**.
+
+### Look at or restore an earlier revision
+
+1. Open **History** in the section rail.
+2. Pick a revision from **Project history** (the current one is marked **Current**).
+3. At the top, one row of buttons: **Restore this revision** (the main action), **Download all images** (a zip of that revision's images) and one **Open folder** for the revision.
+4. Below, each output is listed with its state, **Download** and **Preview retained output**. Earlier results are marked **Earlier result**. Retained narration parts play in Slopify's own audio player, and text parts can be opened too.
+5. Press **Restore this revision** to make it current again.
+
+Restoring adds a new revision with the old settings and outputs, so nothing after it is lost. A restored revision takes its channel back.
+
+## Save as template
+
+**More project actions → Save as template…** saves this project's settings as a template for Play and Schedules. Keywords the title names are saved empty; other keyword values are kept. See [Templates](Templates).
+
+## Tips
+
+- Several edits can go into one save. Make them all, save once, then review the remake.
+- A rejected save lists each problem next to its field; fix those and save again.
+- To redo a whole stage from scratch rather than one piece, use the section's own More menu on the project page (see [Project Page](Project-Page#re-run-a-whole-stage)).
+
+## Related pages
+
+- [Project Page](Project-Page)
+- [Video Editing](Video-Editing)
+- [Recovery and Retries](Recovery-and-Retries)
+- [Prompts](Prompts)
+- [Narration Aliases and Glossary](Narration-Aliases-and-Glossary)
+- [Costs and Run Cost](Costs-and-Run-Cost)