This guide takes you all the way from zero to a live documentation site: creating a project, writing with blocks, getting it reviewed, customizing the look, and...
This guide takes you all the way from zero to a live documentation site: creating a project, writing with blocks, getting it reviewed, customizing the look, and...
This guide takes you all the way from zero to a live documentation site: creating a project, writing with blocks, getting it reviewed, customizing the look, and publishing. Follow it start to finish and you'll have a real, polished docs site — and understand every major part of Doxbrix.
Who this is for
Anyone setting up documentation in Doxbrix for the first time. No prior experience needed. Budget about 20 minutes.
Step 1 — Create a project
From the Dashboard, click New project to open Create a new project.
In Start with a template, pick Product Documentation for a general docs site. Not sure? See Choose a template.
Set the Project name, Brand color, Visibility, and Editor mode, then click Create project.
Your project opens in the editor with a navigable structure already in place. See the Quickstart for a field-by-field tour of the form.
Step 2 — Get oriented
Your content is organized as spaces (top-bar sections), groups (sidebar sections), and pages (documents) — all in the content tree on the left. See Core concepts. Find the Get started group in the tree.
Step 3 — Write your first page
Click the Introduction page in the Get started group.
Replace the placeholder text. Press <kbd>/</kbd> to insert blocks — try a <Steps> block for a procedure and a <Tip> callout.
Insert an Image (/image) for a screenshot, or a Mermaid diagram (/flowchart) to explain a flow.
Watch the Quality badge and document insights — aim for Excellent (88+).
Go to Settings → Project → Branding.
Set the Primary color, Theme mode, and upload a Light logo / Dark logo.
Click Preview to see your site with the new branding.
Click Preview in the top bar to see the page as readers will.
Click Publish (or Submit for review if approval is required). Use the split menu's Publish whole section to ship a group at once.