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.devwith 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 |
| 2. Write | Docup reads your files, plans the pages and writes them as drafts. | How Docup works |
| 3. Review | Read the draft, edit what you want, and retry any page that failed. | The page editor |
| 4. Publish | One click puts the draft live at your Docup address. | Publishing your site |
| 5. Stay current | Each push to your default branch updates the pages it affects. | Keeping docs up to date |
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.
Start here#
- New to Docup? Follow Getting started to publish your first site.
- Want to understand what the AI does and does not do? Read How Docup works.
- Looking for a number such as a daily limit or a file size? See Limits.
- Something went wrong? Try Troubleshooting.
Explore the docs
- Getting startedSign in, connect a GitHub repository, choose an address and publish your first documentation site.
- How Docup worksHow Docup reads a repository, plans pages, writes them, and keeps drafts, live pages and your own edits apart.
- Drafts and live pagesWhy every change is a draft first, what readers see, and exactly what publishing copies to the live site.
- Your edits and page sourcesHow Docup knows a page is yours, why it never overwrites your wording, and how pages stay linked to the files they came from.
- What Docup readsThe branch, the files and the limits that decide what the AI is allowed to see in your repository.
- Connecting GitHubUse the Docup GitHub App for private repositories and push updates, or paste a public repository link.
- The dashboardA tour of the project dashboard: Overview, Pages, Analytics, Runs, Ask AI and Settings.
- Get better docs from your repositoryPrepare your repository, write useful instructions, and review a draft so the first run is close to publishable.