# Glossary

Definitions of the terms used across Docup and these docs.

This reference page defines the core terms and concepts used across Docup and its documentation. Use these definitions to understand the differences between drafts and live pages, the steps of the writing pipeline, and how Docup connects to GitHub.

## Terminology

| Term | Meaning |
| --- | --- |
| **AI version** | The last text the AI wrote for a page. A page differing from it is "edited by you". See [Your edits and page sources](/concepts/edits-and-sources). |
| **Ask AI** | The chat on a published site that answers from live pages. See [Ask AI](/guides/ask-ai). |
| **Callout** | A highlighted note, tip or warning box, written as `:::note`, `:::tip` or `:::warning`. See [Markdown reference](/docs-site/markdown-reference). |
| **Default branch** | The branch Docup reads and follows, such as `main`. |
| **Docs address** | The part before `.docup.dev` that names your site. Also called the subdomain. See [Site and domain](/settings/domain). |
| **Draft** | The version of a page you edit. Not visible to readers. See [Drafts and live pages](/concepts/drafts-and-live). |
| **Edited by you** | A page whose text differs from the AI version. Protected from automatic rewrites. See [Your edits and page sources](/concepts/edits-and-sources). |
| **Failed page** | A page Docup could not write. Can be retried or written by hand. See [Runs](/guides/runs). |
| **Generated from** | The repository files a page was written from. See [Your edits and page sources](/concepts/edits-and-sources). |
| **GitHub App** | The Docup application you install on GitHub to give read access to private repositories and to send push notifications. See [Connecting GitHub](/guides/connect-github). |
| **Ignore path** | A folder or pattern you ask Docup never to read. See [What Docup reads](/concepts/what-docup-reads). |
| **Instructions** | Free-text guidance on audience, tone and scope for the AI writer. See [AI guidance](/settings/guidance). |
| **llms.txt** | A file that indexes your docs for AI tools. `llms-full.txt` holds every page. See [Optimize for search and AI answers](/guides/seo-and-ai-search). |
| **Live** | The version of a page readers see. Made by publishing. See [Drafts and live pages](/concepts/drafts-and-live). |
| **Outline** | The "On this page" list of a page's headings. See [What readers get](/docs-site/reader-features). |
| **Page path** | A page's address, such as `guides/editor`. See [Organize pages and folders](/guides/organize-pages). |
| **Planner** | The AI step that decides which pages a project needs. See [How Docup works](/concepts/how-it-works). |
| **Preview** | A private view of the draft site, for members of your workspace. See [Drafts and live pages](/concepts/drafts-and-live). |
| **Project** | A repository and its docs site. See [Getting started](/getting-started). |
| **Publish** | Copy the draft text, paths and order of every page to the live site. See [Publishing your site](/guides/publishing). |
| **Push** | A commit sent to GitHub. A push to the default branch can start an update. See [Keeping docs up to date](/guides/updates). |
| **Run** | One job of the writing pipeline: a sync, a page retry or an update. See [Runs](/guides/runs). |
| **Snapshot** | The set of files, after filtering, that the AI reads during a run. See [What Docup reads](/concepts/what-docup-reads). |
| **Source file** | A repository file a page was written from. See [Your edits and page sources](/concepts/edits-and-sources). |
| **Suggestion** | An AI update to a page you edited, waiting for your review. See [Review suggestions](/guides/review-suggestions). |
| **Sync** | The first run, which writes the whole site. See [Runs](/guides/runs). |
| **Update** | A run after a push that brings affected pages up to date. See [Keeping docs up to date](/guides/updates). |
| **Workspace** | The account that owns projects. Every new user gets a personal workspace. |
| **Writer** | The AI step that writes or updates one page. See [How Docup works](/concepts/how-it-works). |