# Overview

Docup turns a GitHub repository into a hosted, searchable documentation site and keeps it up to date as your code changes.

Docup turns a GitHub repository into a documentation site. It reads your code, plans a set of pages, writes each one, and lets you review and edit everything before readers see a word. Once the site is live, Docup watches your default branch and brings the affected pages up to date after every push.

This site is itself a Docup site. It is the documentation of Docup, built from Docup's own repository.

## What you get

- **A first draft in minutes.** Docup plans up to 15 pages for your project and writes them from your code. Nothing is public until you publish.
- **A visual editor.** Edit pages like a document, with slash commands, callouts, tables and autosave. There is no Markdown to manage by hand.
- **A hosted site.** Publish to `your-project.docup.dev` with search, a table of contents, dark mode, syntax-highlighted code and previous/next links.
- **Docs that follow your code.** Push to your default branch and the pages written from the changed files are rewritten. Pages you edited by hand are never overwritten; you get a suggestion to review instead.
- **Ask AI for readers.** A chat on your site answers questions from your published pages only, and links the pages it used.
- **Built for search and AI tools.** Every site ships with a sitemap, `robots.txt`, `llms.txt`, a Markdown copy of each page, structured data and generated social images.
- **Analytics without cookies.** See views, visitors, referrers and which AI crawlers read your docs.

## How it works


| Step            | What happens                                                                                 | Learn more                                  |
| --------------- | -------------------------------------------------------------------------------------------- | ------------------------------------------- |
| 1. Connect      | Paste a public repository link, or install the Docup GitHub App to use private repositories. | [Connecting GitHub](/guides/connect-github) |
| 2. Write        | Docup reads your files, plans the pages and writes them as drafts.                           | [How Docup works](/concepts/how-it-works)   |
| 3. Review       | Read the draft, edit what you want, and retry any page that failed.                          | [The page editor](/guides/editor)           |
| 4. Publish      | One click puts the draft live at your Docup address.                                         | [Publishing your site](/guides/publishing)  |
| 5. Stay current | Each push to your default branch updates the pages it affects.                               | [Keeping docs up to date](/guides/updates)  |


> **Note:** Docup only reads your repository. It never writes to it. Secrets, lockfiles, binaries and anything you list as an ignore path never reach the AI. See [Security and privacy](/reference/security).

## Start here

- New to Docup? Follow [Getting started](/getting-started) to publish your first site.
- Want to understand what the AI does and does not do? Read [How Docup works](/concepts/how-it-works).
- Looking for a number such as a daily limit or a file size? See [Limits](/reference/limits).
- Something went wrong? Try [Troubleshooting](/reference/troubleshooting).