Quickstart

Getting started

This 10–15 minute path takes you from zero to a published, branded docs site.

Before you begin

• Account created and signed in

• You belong to (or created) an organization

• Role permissions: Member can write; Admin/Owner can create sites, publish, and manage domains

Create a space

1. Open the sidebar → Spaces → Create space

2. Name it (for example, “User Guide”), optionally pick an icon and description

Add your first page

1. Inside the space, click New page

2. Type a title, then start writing in the editor

3. Type / to open the slash menu for headings, lists, code blocks, tables, tabs, etc.

(Optional) Import API reference

1. Add a document of type “API Spec” (from the space tree actions)

2. Paste your OpenAPI 3.0/3.1 JSON or YAML and click Upload, then Process

3. Docufy generates endpoint pages and tag groups under the spec

Create a site and select spaces

1. Sidebar → Sites → Create site

2. Name and save; open the site page

3. In Content, add one or more spaces and order them

Brand and theme

1. In Appearance, upload light/dark logos and a favicon

2. Open Theme Studio to adjust brand colors, surfaces, and layout tokens

Publish

1. Go to Deploys → Publish

2. Watch the build progress and then click the primary host link to view your docs

3. Blazing fast customer facing documentation is ready!

Add a custom domain

1. Open Domains → Add domain (e.g., docs.example.com)

2. Follow the DNS instructions shown for your domain type (CNAME for subdomains; A/AAAA for apex)

3. Click Check now to verify; SSL is issued automatically after DNS propagates

4. Republish the site after verification is completed