FAQ

Answers to common questions about Docup, including pricing, repository access, updates, custom domains, and how the AI writes your documentation.

General#

What is Docup?#

Docup turns a GitHub repository into a hosted documentation site. It reads your code, writes the pages with AI, lets you edit and publish them, and updates them when your code changes. See the Overview.

Is it free?#

Docup is free while it is in early access. Early access has limits, listed in Limits. Paid plans with higher limits are planned, and nothing is charged without your agreement.

Which languages and frameworks does it support?#

Docup reads text files, so it works on any language. The quality of the draft depends on what the repository says about itself, not on the language. See Get better docs from your repository.

Do I have to use Markdown?#

No. The editor is visual. Pages are stored as Markdown, and you can read it at /<page>.md on your site.

Repositories#

Does it work with private repositories?#

Yes, through the Docup GitHub App. You choose which repositories the app can see. See Connecting GitHub.

Does Docup change my repository?#

No. It reads files and compares commits. It never pushes or opens pull requests.

Which branch does it use?#

The default branch, always.

Can I document a monorepo or a subfolder?#

Docup reads the whole repository. A link to a folder works, but it documents the repository, so use ignore paths to leave out what you do not want covered. Instructions can also tell the writer which part to focus on.

Can I connect several repositories?#

Each repository is its own project with its own site. A repository can be a project once per workspace. Adding a second project from the dashboard is marked as coming soon.

Writing and updates#

Who writes the docs?#

An AI planner and writer, from the files that pass the filter. You review and edit every page before readers see it.

Is the AI accurate?#

It is told to state only what it verified in the code, and not to guess commands, options or defaults. It can still be wrong or incomplete, so read the draft, run the examples and check names before you publish.

What happens when I push code?#

For repositories connected through the GitHub App, Docup compares the new commit with the last one it documented and updates the pages written from changed files. Workspaces can run up to 15 updates that use AI per UTC day. Pushes that do not change any documented code are free and do not count toward this limit. See Keeping docs up to date.

Will it overwrite my edits?#

Never. Edited pages get a suggestion you can review, apply or dismiss. See Review suggestions.

Why did a live page change without me publishing?#

A page you have not edited, on a live site, follows your code. Edit it once to take control.

Can I regenerate everything?#

Regenerating all pages is marked as coming soon. You can retry a failed page today, and you can add pages by hand.

Sites and domains#

Where do my docs live?#

At your-address.docup.dev. You choose the address and can change it later.

Can I use my own domain?#

Yes. Add your own domain (such as docs.yourcompany.com) in settings, point it at Docup with one DNS record, and your docs will move there once verified. Until then, they stay on your docup.dev address. See Site and domain.

Can I make the docs private?#

Private docs are marked as coming soon. Today every published site is public.

Is the site fast?#

Pages are server-rendered and cached after the first view. See Performance.

AI and search#

What is Ask AI?#

A chat on your published site that answers from your published pages and links its sources. See Ask AI.

Will search engines find my docs?#

Yes, unless you turn search engines off. Docup provides titles, descriptions, canonical links, structured data and a sitemap. See Optimize for search and AI answers.

Can I stop AI crawlers?#

Yes. Turn off AI crawlers in Search and sharing.

Privacy#

Do you use cookies for analytics?#

No. See Analytics and Security and privacy.

Does the AI train on my code?#

Docup sends the files that pass its filter to the AI model that writes your docs, for the length of a run. See Security and privacy for what is filtered first.