This guide walks you through connecting an existing documentation site (Docusaurus, MkDocs, or another supported generator) to Doxbrix. By the end, you will have...
This guide walks you through connecting an existing documentation site (Docusaurus, MkDocs, or another supported generator) to Doxbrix. By the end, you will have...
This guide walks you through connecting an existing documentation site (Docusaurus, MkDocs, or another supported generator) to Doxbrix. By the end, you will have a live site with an AI assistant, reader analytics, and content gap detection — all without changing your source files.
What you need
- A Doxbrix workspace (any plan)
- A Git repository containing a working documentation site
- The repository must be publicly accessible, or Doxbrix must be able to reach it
Step 1 — Start a new Connected Docs project
From the Doxbrix dashboard, click New project and choose Connected Docs.
You will see the setup wizard. Select Git repository as your source.
Step 2 — Connect your repository
Paste your repository URL into the field and click Check.
Doxbrix will validate the URL and detect your documentation generator automatically. You should see a confirmation similar to:
If your docs live in a subdirectory (for example docs/ or website/), select it from the folder picker. Otherwise leave the default.
Step 3 — Configure the project
Fill in the project details:
- Project name — give it a clear name (e.g. "Product Docs")
- Landing experience — choose Docs first to keep your existing homepage, or Assistant first if most readers arrive with a question
- Visibility — choose Public for an open docs site, or Private if only workspace members (or authenticated readers) should have access
Click Next.
Step 4 — Review and create
The review screen summarizes your choices and shows the URL your site will be live at.
If everything looks correct, click Create project. Doxbrix will start the build pipeline.
Step 5 — Watch the build
The build progress screen shows each stage in real time:
- Clone
- Detect
- Install
- Build
- Index & Infuse
- Deploy
A typical build for a mid-sized docs site takes 2–4 minutes. If a stage fails, Doxbrix shows an error with an actionable hint and a link to the full build log.
Step 6 — Visit your live site
When the build completes, click the link to your live site. You should see your documentation exactly as it looked before, plus an AI assistant button — either floating in the corner or in the header, depending on your landing experience choice.
Click the assistant button and ask a question about your docs to verify it is working.
Step 7 — Enable auto-deploy
Right now, updates to your repository will not automatically rebuild the site. Set up auto-deploy so every push keeps the site current.
Go to Project settings → Deployments and choose Webhook. Follow the instructions to register the webhook in your Git host (GitHub, GitLab, etc.). From that point on, every push to your default branch will trigger a rebuild within seconds.
See Auto-deploy for the full configuration guide.
Step 8 — Review reader insights
After your site has been live for a day or two, open Manage → Analytics to see:
- Questions readers asked the AI assistant
- Pages that received the most questions (potential gaps or unclear sections)
- Unanswered questions flagged as content gaps
Use this data to prioritize which documentation to improve next.