Quickstart
Nothing to install and no card. A GitHub account is optional, and every new account starts with a 14-day Pro trial that includes $5 of AI credit (pricing).
Create your site#
The New project screen walks through three steps — Start, Your project, Your agent — and only the first one needs an answer. Already signed in, you get the same steps from Create new project in the panel's project switcher.
The first tile imports a repository: Connect GitHub, or Select repository once GitHub is connected. Every other tile is a template — 38 of them in 9 categories, from Docs shell to REST API — pictured with the pages it will create.
Every field on Tell us about your project is optional:
- Project name — the site's title, and its address when Docsbook hosts it
- Main site — read for your colours, logo and fonts, and the site the agent checks facts against
- Add website — up to four more sites, connected as sources
- Attachments — PDF, DOCX and Markdown files become pages; pictures become images any page can use
- What does your product do? — a paragraph only your agent reads, never published
Copy the one-line prompt for the agent you already use, pick Channels where the Docsbook agent posts what it finds (Slack, Telegram and more), and add Instructions or a Model if you want to. All of it can wait for the panel.
Press Create Agent and Project. Signed out, you choose Continue with GitHub (recommended — it lets agents commit to your repo), Continue with Google or Continue with Email with a 6-digit code. Your answers survive the sign-in, and the project exists as soon as you're in.
You land in the project's panel with the site already live. A new project built from a template, with a site, a description or files to work from, starts the one-time trigger Generate docs from your site — or Generate docs from your brief without a site — and the agent's report arrives in Inbox.
The run replaces the template's placeholder wording with your product's real names, features and steps. It is told never to invent a price, a limit or an integration: what it can't confirm comes back as questions in the report.
Which starting point fits?#
Only importing a repository needs GitHub. A template runs on a repository Docsbook creates and hosts for you.
Choose Connect GitHub, then your repository. Its Markdown becomes the site as it stands: Docsbook reads it, writes nothing back, and the one-time run doesn't start. Nothing rewrites your pages until you ask the agent or arm a trigger.
Pick a template — Docs shell is the blank one — and put your site in Main site. Generate docs from your site reads about ten of its pages, pricing, features and existing docs first, and rewrites the template pages about your product.
No site yet? Pick a template, fill in What does your product do? and attach any files or screenshots. Generate docs from your prompt drafts the docs from that material alone and removes the template pages it says nothing about.
Where does your site live?#
Every site gets a docsbook.io address the moment it's created:
| You started from | Your site's address |
|---|---|
| A template (Docsbook hosts the repo) | https://<project-name>.docsbook.io |
| Your GitHub repository | https://<owner>.docsbook.io/<repo> |
| Either, on your own domain | https://docs.example.com — see custom domain |
Change the name in the address on Settings ▸ General ▸ Site source; nothing on GitHub moves. For a repository site, docsbook.io/<owner>/<repo> redirects to its address too.
Hand the rest to your agent#
From here the Docsbook agent does the work. Paste one sentence into Claude Code, Cursor, Codex or ChatGPT and it connects itself:
Set up Docsbook for me. Fetch https://docsbook.io/get-started.md and follow it.Then ask for outcomes in your own words — "document our API from the repo", "get us cited in AI answers" — as Tell your agent, get discovered shows. To keep work coming without asking, arm ready-made triggers such as Organic search audit or Answer what the chat could not.
FAQ#
Does Docsbook change my repository? Not when you import it. Later, each change the agent makes arrives as a pull request that merges itself or waits for you, set on Settings ▸ General ▸ When a change goes live (reviewing changes).
Why didn't the first run start? It runs once, only for a new project built from a template with something to work from, and only when your balance covers a run. Otherwise your attached files are published as pages as they are, and you can ask the agent at any time.