A Connected Docs project starts from either a **Git repository** or a **prebuilt bundle** (a zip of your built site). Choose the path that matches how your docs...
A Connected Docs project starts from either a **Git repository** or a **prebuilt bundle** (a zip of your built site). Choose the path that matches how your docs...
A Connected Docs project starts from either a Git repository or a prebuilt bundle (a zip of your built site). Choose the path that matches how your docs are maintained.
Prerequisites
- A Doxbrix workspace with at least one project slot available
- A Git repository containing a supported documentation site, or a prebuilt
.zipof your site's build output - Repository is publicly accessible, or you have a URL Doxbrix can reach
Start the setup wizard
From the Doxbrix dashboard, click New project and select Connected Docs. The wizard walks you through six steps.
Select Git repository or Upload bundle.
- Git repository — Doxbrix clones, builds, and deploys from your repo on every update.
- Upload bundle — You supply a prebuilt
.zipof your static site output. No build step runs; Doxbrix hosts and infuses it directly.
For most teams with an active docs site, Git repository is the right choice.
Paste your repository URL and click Check.
Doxbrix will:
- Confirm the repository is reachable
- Detect the documentation generator (Docusaurus, MkDocs, Hugo, etc.)
- Identify the default branch
- Suggest any subdirectories that contain a docs configuration file
If your docs live in a subfolder (e.g. docs/ or website/), select it from the folder picker. If the root is correct, leave it blank.
Set the project details:
| Col 1 | Field | Description |
|---|---|---|
| **Project name** | Auto-populated from your repo name. Edit it to match how the project should appear in your workspace. | |
| **Landing experience** | **Docs first** opens on your documentation index. **Assistant first** opens on the AI assistant page — useful for support-focused sites. | |
| **Visibility** | **Public** — anyone with the URL can read it. **Private** — workspace members only, with optional reader authentication. |
If you chose Private, configure how readers authenticate:
- Password protection
- Allowed email domains
- SSO (if configured in your workspace)
You can change access settings at any time from Project settings → Reader Access.
Confirm your choices before the first build runs. The summary shows your repository URL, detected generator, project name, landing experience, visibility, and the live URL Doxbrix will assign.
Click Back to adjust anything, or Create project to start the build.
Doxbrix runs the build pipeline in real time. Progress is shown stage by stage:
- Clone — repository is checked out at the latest commit
- Detect — generator and build config are confirmed
- Install — dependencies are installed
- Build — your normal build command runs
- Index & Infuse — content is indexed; AI assistant is injected into the output
- Deploy — site goes live
If a stage fails, Doxbrix shows a friendly error message with an actionable hint and a link to the full build log. You can retry the build or discard it and adjust settings.
When the build completes, you will see a confirmation screen with a link to your live site.
Upload a bundle
If you selected Upload bundle at step 1, the wizard replaces the Connect step with an upload step. After completing Configure and Review, you will be prompted to drag and drop or browse for a .zip file containing your built site output.
build/ folder; zip the contents of that folder, not the folder itself.After upload, Doxbrix infuses and deploys the bundle. To update the site, upload a new zip from Project settings → Deployments.
Verify the live site
Once the build completes, open the live URL. You should see your documentation site with an AI assistant button visible (floating or in the header, depending on your landing experience choice).